Enum SpanKind

#[repr(i32)]
pub enum SpanKind {
    Unspecified = 0,
    Internal = 1,
    Server = 2,
    Client = 3,
    Producer = 4,
    Consumer = 5,
}

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

SpanKind is the type of span. Can be used to specify additional relationships between spans in addition to a parent/child relationship.

Variants

Unspecified = 0

Unspecified. Do NOT use as default. Implementations MAY assume SpanKind to be INTERNAL when receiving UNSPECIFIED.

Internal = 1

Indicates that the span represents an internal operation within an application, as opposed to an operation happening at the boundaries. Default value.

Server = 2

Indicates that the span covers server-side handling of an RPC or other remote network request.

Client = 3

Indicates that the span describes a request to some remote service.

Producer = 4

Indicates that the span describes a producer sending a message to a broker. Unlike CLIENT and SERVER, there is often no direct critical path latency relationship between producer and consumer spans. A PRODUCER span ends when the message was accepted by the broker while the logical processing of the message might span a much longer time.

Consumer = 5

Indicates that the span describes consumer receiving a message from a broker. Like the PRODUCER kind, there is often no direct critical path latency relationship between producer and consumer spans.

Implementations

impl SpanKind

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of SpanKind.

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

👎Deprecated: Use the TryFrom<i32> implementation instead

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

impl SpanKind

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 SpanKind

fn clone(&self) -> SpanKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpanKind

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

Formats the value using the given formatter.

impl Default for SpanKind

fn default() -> SpanKind

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SpanKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SpanKind> for SpanKind

fn from(span_kind: SpanKind) -> Self

Converts to this type from the input type.

impl From<SpanKind> for i32

fn from(value: SpanKind) -> i32

Converts to this type from the input type.

impl Hash for SpanKind

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 SpanKind

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

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

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

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 SpanKind

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for SpanKind

impl Eq for SpanKind

impl StructuralPartialEq for SpanKind