Struct Tag

pub struct Tag(/* private fields */);

An opaque, unique tag identifying a value’s Metadata and profile.

A Tag is retrieved either via Tagged or Value::tag(). The corresponding metadata can be retrieved via Figment::get_metadata() and the profile vile Tag::profile().

Implementations

impl Tag

pub const Default: Tag = _

The default Tag. Such a tag will never have associated metadata and is associated with a profile of Default.

pub const fn is_default(self) -> bool

Returns true if self is Tag::Default.

Example

use figment::value::Tag;

assert!(Tag::Default.is_default());

pub fn profile(self) -> Option<Profile>

Returns the profile self refers to if it is either Profile::Default or Profile::Custom; otherwise returns None.

Example

use figment::Profile;
use figment::value::Tag;

assert_eq!(Tag::Default.profile(), Some(Profile::Default));

Trait Implementations

impl Clone for Tag

fn clone(&self) -> Tag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tag

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

Formats the value using the given formatter.

impl Default for Tag

fn default() -> Tag

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Tag

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Tag> for Value

fn from(tag: Tag) -> Value

Converts to this type from the input type.

impl Hash for Tag

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Tag

fn cmp(&self, other: &Tag) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Tag

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Tag

fn partial_cmp(&self, other: &Tag) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Tag

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Tag

impl Eq for Tag