Struct ApiMetadata 

pub struct ApiMetadata {
    pub trace_id: String,
    pub request_id: String,
    pub graph_version: u64,
    pub index_version: Option<u64>,
    pub indexed_graph_version: Option<u64>,
    pub stale: bool,
}

Common metadata that every successful API response must carry.

Fields

trace_id: String

request_id: String

graph_version: u64

index_version: Option<u64>

indexed_graph_version: Option<u64>

stale: bool

Implementations

impl ApiMetadata

pub fn graph_only(context: &RequestContext, graph_version: GraphVersion) -> Self

Builds response metadata for graph-only operations.

pub fn indexed( context: &RequestContext, graph_version: GraphVersion, index_version: Option<u64>, indexed_graph_version: Option<GraphVersion>, stale: bool, ) -> Self

Builds response metadata for operations that used derived indexes.

Trait Implementations

impl Clone for ApiMetadata

fn clone(&self) -> ApiMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ApiMetadata

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ApiMetadata

impl StructuralPartialEq for ApiMetadata