Skip to main content

Service

Struct Service 

Source
pub struct Service { /* private fields */ }
Expand description

A source-aware typed Compose service.

Implementations§

Source§

impl Service

Source

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

Returns the service name.

Source

pub const fn span(&self) -> SourceSpan

Returns the complete service definition span.

Source

pub const fn image(&self) -> Option<&Located<ImageReference>>

Returns the explicitly authored image reference.

Source

pub const fn command(&self) -> Option<&Command>

Returns the command without normalizing its authored form.

Source

pub const fn environment(&self) -> Option<&Environment>

Returns environment variables with list and mapping forms kept distinct.

Source

pub const fn extra_hosts(&self) -> Option<&ExtraHosts>

Returns additional host mappings with short and long forms retained.

Source

pub const fn user(&self) -> Option<&UserSpec>

Returns the raw-preserving container user/group value.

Source

pub const fn userns_mode(&self) -> Option<&UserNamespaceMode>

Returns the raw-preserving user-namespace mode.

Source

pub const fn ulimits(&self) -> Option<&Ulimits>

Returns explicitly authored service resource limits.

Source

pub const fn depends_on(&self) -> Option<&DependsOn>

Returns service dependencies with short and long forms retained.

Source

pub const fn healthcheck(&self) -> Option<&Healthcheck>

Returns the service health-check definition.

Source

pub const fn build(&self) -> Option<&Build>

Returns the build declaration with short and long forms retained.

Source

pub const fn deploy(&self) -> Option<&DeployDefinition>

Returns independently classified deploy subfields.

Source

pub fn ports(&self) -> &[Port]

Returns published ports in authored order.

Source

pub fn volumes(&self) -> &[VolumeMount]

Returns service-volume mounts in authored order.

Source

pub const fn networks(&self) -> Option<&ServiceNetworks>

Returns service network attachments with short and long forms kept distinct.

Source

pub fn profiles(&self) -> &[Located<String>]

Returns explicitly authored profile names.

Source

pub fn configs(&self) -> &[ConfigGrant]

Returns service config grants in authored order.

Source

pub fn secrets(&self) -> &[SecretGrant]

Returns service secret grants in authored order.

Source

pub fn extension_fields(&self) -> &[FieldReference]

Returns retained service x- extension fields.

Source

pub fn unknown_fields(&self) -> &[FieldReference]

Returns service fields not yet represented by the typed subset.

Trait Implementations§

Source§

impl Clone for Service

Source§

fn clone(&self) -> Service

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Service

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Service

Source§

impl PartialEq for Service

Source§

fn eq(&self, other: &Service) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Service

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.