Skip to main content

EnvironmentFile

Struct EnvironmentFile 

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

One ordered environment-file declaration.

This value describes source intent only. Importing it never reads the referenced file. A caller that wants to materialize environment values must cross a separate filesystem-access boundary and apply the source implementation’s parsing rules explicitly.

Implementations§

Source§

impl EnvironmentFile

Source

pub fn new( path: ProtectedString, syntax: EnvironmentFileSyntax, ) -> Result<Self, ModelError>

Creates an environment-file declaration with a non-empty path.

§Errors

Returns ModelError::EmptyValue or ModelError::ContainsNul.

Source

pub const fn path(&self) -> &ProtectedString

Returns the source-authored path without resolving or reading it.

Source

pub const fn syntax(&self) -> EnvironmentFileSyntax

Returns the authored short/long syntax family.

Source

pub fn set_required(&mut self, required: Sourced<bool>)

Retains an explicit required/optional choice.

Source

pub const fn required(&self) -> Option<&Sourced<bool>>

Returns the explicit required/optional choice, if authored.

Source

pub fn is_required(&self) -> bool

Returns whether the source requires the file, including the default of true.

Source

pub fn set_format(&mut self, format: Sourced<EnvironmentFileFormat>)

Retains an explicitly selected parsing mode.

Source

pub const fn format(&self) -> Option<&Sourced<EnvironmentFileFormat>>

Returns the explicitly selected parsing mode, if authored.

Trait Implementations§

Source§

impl Clone for EnvironmentFile

Source§

fn clone(&self) -> EnvironmentFile

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 EnvironmentFile

Source§

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

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

impl Eq for EnvironmentFile

Source§

impl PartialEq for EnvironmentFile

Source§

fn eq(&self, other: &EnvironmentFile) -> 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 EnvironmentFile

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<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.