package
0.5.0
Repository: https://github.com/form3tech-oss/libcompose.git
Documentation: pkg.go.dev

# Packages

Package events holds event structures, methods and functions.
No description provided by the author

# Functions

DefaultDependentServices return the dependent services (as an array of ServiceRelationship) for the specified project and service.
IsNamedVolume returns whether the specified volume (string) is a named volume or not.
NameAlias returns the name and alias based on the specified string.
NewDefaultListener create a default listener for the specified project.
NewProject creates a new project with the specified context.
NewServiceRelationship creates a new Relationship based on the specified alias and relationship type.

# Constants

Definitions of filter states.
ComposeVersion is name of docker-compose.yml file syntax supported version.
RelTypeDependsOn means the dependency was explicitly set using 'depends_on'.
RelTypeIpcNamespace means the service share the same ipc namespace.
RelTypeLink means the services are linked (docker links).
RelTypeNetNamespace means the services share the same network namespace.
RelTypeNetworkMode means the services depends on another service on networkMode.
RelTypeVolumesFrom means the services share some volumes.
Definitions of filter states.
Definitions of filter states.

# Variables

Error definitions.
Error definitions.
State definitions.
State definitions.

# Structs

Context holds context meta information about a libcompose project, like the project name, the compose file, etc.
EmptyNetworks is a struct that implements Networks but does nothing.
EmptyService is a struct that implements Service but does nothing.
ExportedConfig holds config attribute that will be exported.
Filter holds filter element to filter containers.
Project holds libcompose project information.
ServiceRelationship holds the relationship information between two services.

# Interfaces

APIProject defines the methods a libcompose project should implement.
Container defines what a libcompose container provides.
Networks defines the methods a libcompose network aggregate should define.
NetworksFactory is an interface factory to create Networks object for the specified configurations (service, networks, …).
RuntimeProject defines runtime-specific methods for a libcompose implementation.
Service defines what a libcompose service provides.
ServiceFactory is an interface factory to create Service object for the specified project, with the specified name and service configuration.
Volumes defines the methods a libcompose volume aggregate should define.
VolumesFactory is an interface factory to create Volumes object for the specified configurations (service, volumes, …).

# Type aliases

Info holds a list of InfoPart.
InfoSet holds a list of Info.
ServiceRelationshipType defines the type of service relationship.
ServiceState holds the state of a service.
State defines the supported state you can filter on.