Enum opentelemetry_proto::tonic::trace::v1::SpanFlags

#[repr(i32)]
pub enum SpanFlags {
    DoNotUse = 0,
    TraceFlagsMask = 255,
    ContextHasIsRemoteMask = 256,
    ContextIsRemoteMask = 512,
}

Available on crate features gen-tonic-messages and trace only.

SpanFlags represents constants used to interpret the Span.flags field, which is protobuf ‘fixed32’ type and is to be used as bit-fields. Each non-zero value defined in this enum is a bit-mask. To extract the bit-field, for example, use an expression like:

(span.flags & SPAN_FLAGS_TRACE_FLAGS_MASK)

See https://www.w3.org/TR/trace-context-2/#trace-flags for the flag definitions.

Note that Span flags were introduced in version 1.1 of the OpenTelemetry protocol. Older Span producers do not set this field, consequently consumers should not rely on the absence of a particular flag bit to indicate the presence of a particular feature.

Variants

DoNotUse = 0

The zero value for the enum. Should not be used for comparisons. Instead use bitwise “and” with the appropriate mask as shown above.

TraceFlagsMask = 255

Bits 0-7 are used for trace flags.

ContextHasIsRemoteMask = 256

Bits 8 and 9 are used to indicate that the parent span or link span is remote. Bit 8 (HAS_IS_REMOTE) indicates whether the value is known. Bit 9 (IS_REMOTE) indicates whether the span or link is remote.

ContextIsRemoteMask = 512

Implementations

impl SpanFlags

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of SpanFlags.

pub fn from_i32(value: i32) -> Option<SpanFlags>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a SpanFlags, or None if value is not a valid variant.

impl SpanFlags

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for SpanFlags

fn clone(&self) -> SpanFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpanFlags

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

Formats the value using the given formatter.

impl Default for SpanFlags

fn default() -> SpanFlags

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SpanFlags

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SpanFlags> for i32

fn from(value: SpanFlags) -> i32

Converts to this type from the input type.

impl Hash for SpanFlags

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 SpanFlags

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

Restrict a value to a certain interval.

impl PartialEq for SpanFlags

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

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for SpanFlags

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<i32> for SpanFlags

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<SpanFlags, UnknownEnumValue>

Performs the conversion.

impl Copy for SpanFlags

impl Eq for SpanFlags

impl StructuralPartialEq for SpanFlags