Enum compose_spec::Resource

pub enum Resource<T> {
    External {
        name: Option<String>,
    },
    Compose(T),
}

A resource managed either externally or by the compose implementation, e.g. a Network or Volume.

Variants

External

Externally managed resource.

(De)serializes from/to the mapping external: true with an optional name entry.

Fields

name: Option<String>

A custom name for the resource.

Compose(T)

Resource manged by the compose implementation.

Implementations

impl<T> Resource<T>

pub const fn external(name: Option<String>) -> Self

Create a Resource::External with an optional name.

pub const fn is_external(&self) -> bool

Returns true if the resource is External.

pub const fn is_compose(&self) -> bool

Returns true if the resource is managed by the Compose implementation.

pub const fn as_compose(&self) -> Option<&T>

Returns Some if the resource is managed by the Compose implementation.

impl Resource<Network>

pub const fn name(&self) -> Option<&String>

Custom network name, if set.

compose-spec

impl Resource<Volume>

pub const fn name(&self) -> Option<&String>

Custom volume name, if set.

compose-spec

Trait Implementations

impl<T: Clone> Clone for Resource<T>

fn clone(&self) -> Resource<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Resource<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, T: Deserialize<'de>> Deserialize<'de> for Resource<T>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl From<Config> for Resource<Config>

fn from(value: Config) -> Self

Converts to this type from the input type.

impl From<Network> for Resource<Network>

fn from(value: Network) -> Self

Converts to this type from the input type.

impl From<Secret> for Resource<Secret>

fn from(value: Secret) -> Self

Converts to this type from the input type.

impl From<Volume> for Resource<Volume>

fn from(value: Volume) -> Self

Converts to this type from the input type.

impl<T: PartialEq> PartialEq for Resource<T>

fn eq(&self, other: &Resource<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Serialize> Serialize for Resource<T>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<T: Eq> Eq for Resource<T>

impl<T> StructuralPartialEq for Resource<T>