inspect

package

v5.7.1 Latest Latest Go to latest Published: Nov 11, 2026 License: Apache-2.0 Imports: 18 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/docker/compose

Links

Open Source Insights

Documentation ¶

Overview ¶

Package inspect implements the read-only operations that report on a project and its resources: ps, ls, top, port, volumes, events and viz.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Backend ¶

type Backend interface {
	engine.Backend
}

Backend is what the operations need from the engine they report on.

type Service ¶

type Service struct {
	// contains filtered or unexported fields
}

Service runs the inspection operations on a Backend.

func New ¶

func New(backend Backend) *Service

New creates a Service reporting on the given Backend.

func (*Service) Events ¶

func (s *Service) Events(ctx context.Context, projectName string, options api.EventsOptions) error

func (*Service) List ¶

func (s *Service) List(ctx context.Context, options api.ListOptions) ([]api.Stack, error)

func (*Service) Ports ¶

func (s *Service) Ports(ctx context.Context, projectName string, serviceName string, port uint16, options api.PortOptions) (api.PortPublishers, error)

func (*Service) Ps ¶

func (s *Service) Ps(ctx context.Context, projectName string, options api.PsOptions) ([]api.ContainerSummary, error)

func (*Service) Top ¶

func (s *Service) Top(ctx context.Context, projectName string, services []string) ([]api.ContainerProcSummary, error)

func (*Service) Viz ¶

func (s *Service) Viz(_ context.Context, project *types.Project, options api.VizOptions) (string, error)

func (*Service) Volumes ¶

func (s *Service) Volumes(ctx context.Context, projectName string, options api.VolumesOptions) ([]api.VolumesSummary, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL