Enum ScopeKey

pub enum ScopeKey {
    Application = 0,
    CLog,
    Lib,
    // some variants omitted
}

Identifier of the Scope

This identifier is used to distinguish between different scopes in the Context. Its value is unique and used to index the Context’s Vec<Scope>.

Note: This enum is subjected to change in the future because it does not allow for dynamic scope creation. This is a limitation that should be addressed in the future.

Variants

Application = 0

Application scope (default)

This scope is used for the main application and is the default scope. It should be used for the main application and its submodules. Any other scope should be used for libraries or other parts of the application.

CLog

Internal Logging scope

This is a reserved scope for hclog internal logging which can be enabled with HCLOG_DEBUG=1. It is not recommended to use this scope for any other purpose.

Lib

Scope for libraries

Trait Implementations

impl Clone for ScopeKey

fn clone(&self) -> ScopeKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScopeKey

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

Formats the value using the given formatter.

impl Default for ScopeKey

fn default() -> ScopeKey

Returns the “default value” for a type.

impl Display for ScopeKey

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

Formats the value using the given formatter.

impl Hash for ScopeKey

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

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 ScopeKey

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

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

fn partial_cmp(&self, other: &ScopeKey) -> 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 Copy for ScopeKey

impl Eq for ScopeKey

impl StructuralPartialEq for ScopeKey