Struct opentracingrust_zipkin::ZipkinEndpoint

pub struct ZipkinEndpoint {
    pub ipv4: Option<i32>,
    pub port: Option<i16>,
    pub service_name: Option<String>,
    pub ipv6: Option<Vec<u8>>,
}

Indicates the network context of a service recording an annotation with two exceptions.

When a BinaryAnnotation, and key is CLIENT_ADDR or SERVER_ADDR, the endpoint indicates the source or destination of an RPC. This exception allows zipkin to display network context of uninstrumented services, or clients such as web browsers.

Fields

ipv4: Option<i32>

IPv4 host address packed into 4 bytes.

Ex for the ip 1.2.3.4, it would be (1 << 24) | (2 << 16) | (3 << 8) | 4

port: Option<i16>

IPv4 port or 0, if unknown.

Note: this is to be treated as an unsigned integer, so watch for negatives.

service_name: Option<String>

Classifier of a source or destination in lowercase, such as "zipkin-web".

This is the primary parameter for trace lookup, so should be intuitive as possible, for example, matching names in service discovery.

Conventionally, when the service name isn't known, service_name = "unknown". However, it is also permissible to set service_name = "" (empty string). The difference in the latter usage is that the span will not be queryable by service name unless more information is added to the span with non-empty service name, e.g. an additional annotation from the server.

Particularly clients may not have a reliable service name at ingest. One approach is to set service_name to "" at ingest, and later assign a better label based on binary annotations, such as user agent.

ipv6: Option<Vec<u8>>

IPv6 host address packed into 16 bytes. Ex Inet6Address.getBytes()

Methods

impl Endpoint

pub fn new<F1, F2, F3, F4>(
    ipv4: F1,
    port: F2,
    service_name: F3,
    ipv6: F4
) -> Endpoint where
    F1: Into<Option<i32>>,
    F2: Into<Option<i16>>,
    F3: Into<Option<String>>,
    F4: Into<Option<Vec<u8>>>, 

pub fn read_from_in_protocol(
    i_prot: &mut dyn TInputProtocol
) -> Result<Endpoint>

pub fn write_to_out_protocol(
    &self,
    o_prot: &mut dyn TOutputProtocol
) -> Result<()>

Trait Implementations

impl Clone for Endpoint

fn clone(&self) -> Endpoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Endpoint

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

Formats the value using the given formatter.

impl Default for Endpoint

fn default() -> Self

Returns the "default value" for a type.

impl Eq for Endpoint

impl Hash for Endpoint

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Endpoint

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Endpoint> for Endpoint

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Endpoint> for Endpoint

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Endpoint

impl StructuralPartialEq for Endpoint