dotcloud/docker

package mounts // import "github.com/docker/docker/volume/mounts"

import (
    "errors"
    "runtime"

    "github.com/docker/docker/api/types/mount"
)

// ErrVolumeTargetIsRoot is returned when the target destination is root.
// It's used by both LCOW and Linux parsers.
var ErrVolumeTargetIsRoot = errors.New("invalid specification: destination can't be '/'")

// errAnonymousVolumeWithSubpath is returned when Subpath is specified for
// anonymous volume.
var errAnonymousVolumeWithSubpath = errors.New("must not set Subpath when using anonymous volumes")

// errInvalidSubpath is returned when the provided Subpath is not lexically an
// relative path within volume.
var errInvalidSubpath = errors.New("subpath must be a relative path within the volume")

// read-write modes
var rwModes = map[string]bool{
    "rw": true,
    "ro": true, // attempts recursive read-only if possible
}

// Parser represents a platform specific parser for mount expressions
type Parser interface {
    ParseMountRaw(raw, volumeDriver string) (*MountPoint, error)
    ParseMountSpec(cfg mount.Mount) (*MountPoint, error)
    ParseVolumesFrom(spec string) (string, string, error)
    DefaultPropagationMode() mount.Propagation
    ConvertTmpfsOptions(opt *mount.TmpfsOptions, readOnly bool) (string, error)
    DefaultCopyMode() bool
    ValidateVolumeName(name string) error
    ReadWrite(mode string) bool
    IsBackwardCompatible(m *MountPoint) bool
    HasResource(m *MountPoint, absPath string) bool
    ValidateTmpfsMountDestination(dest string) error
    ValidateMountConfig(mt *mount.Mount) error
}

// NewParser creates a parser for the current host OS
func NewParser() Parser {
    if runtime.GOOS == "windows" {
        return NewWindowsParser()
    }
    return NewLinuxParser()
}