Struct Frame 

pub struct Frame {
    pub schema: String,
    pub prefix: String,
    pub module: Vec<String>,
    pub index: u32,
    pub item: Item,
}

One declaration of a producer’s API, as embedded in its library.

Fields

schema: String

The schema version the producer was built with (CURRENT_SCHEMA_VERSION when built by this version).

prefix: String

The C symbol prefix of the crate that declared the item (its library name), which tells a crate’s own frames from a dependency’s.

module: Vec<String>

The path of the module the item belongs to; for a module frame, its parent’s path (empty for a top-level module).

index: u32

The item’s position among its siblings of the same kind (functions among functions, submodules among submodules, and so on), in declaration order.

item: Item

The declaration.

Implementations

impl Frame

pub fn name(&self) -> &str

The declaration’s own name.

pub fn local_path(&self) -> Vec<&str>

The names that locate the declaration inside its module: [name], [interface, name] for a member, and nothing for a module frame.

pub fn path(&self) -> String

The declaration’s dotted path (kv.Store.put, kv.stats).

pub fn symbol(&self) -> String

The name of the exported static that holds the frame: {PREFIX}_META_{HASH16}, where HASH16 is 16 uppercase hex digits of fnv1a64 over the dotted path (followed by a . for a module, so a module and a same-named declaration beside it differ).

pub fn encode(&self) -> Vec<u8>

The frame’s bytes: a little-endian u32 length, then compact JSON.

Panics

Panics if the JSON is longer than u32::MAX bytes.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Frame

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Frame

impl PartialEq for Frame

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Frame

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Frame