Struct TypeSchema 

pub struct TypeSchema { /* private fields */ }

Available on crate feature schema only.

One type’s schema entry in a SchemaSet.

Implementations

impl TypeSchema

pub fn json_schema(document: Value) -> TypeSchema

A json-schema entry from an explicit schema document.

pub fn json_schema_of<T: JsonSchema>() -> TypeSchema

Available on crate feature schemars only.

A json-schema entry derived from a serde type (feature schemars; honors #[serde(...)] attributes).

pub fn protobuf(message: impl Into<String>, descriptor_set: &[u8]) -> TypeSchema

A protobuf entry: the fully-qualified message name and the raw FileDescriptorSet bytes (from prost-build’s file_descriptor_set_path). Serving needs no protobuf dependency — the bytes are carried base64.

pub fn cdr(document: Value) -> TypeSchema

A cdr entry (v1.10) from its document: fields (required), types (optional local type table), and source (optional, informative).

The hash covers fields and types only. The source text is the human’s copy of the schema, not the schema: two producers generating the same message from .msg and from IDL describe the same wire format, and drift detection must not call that a disagreement.

pub fn kind(&self) -> SchemaKind

The kind token this entry serializes under.

pub fn kind_str(&self) -> &str

The kind token, borrowed.

pub fn body(&self) -> &SchemaBody

The entry’s kind-specific fields, typed.

pub fn hash(&self) -> Option<&str>

The sha256: cache/drift key, when the served document carried one.

None is no identity, which is why it is not a &str: an empty string used to mean this, and every caller had to remember to check for it (#323).

pub fn json_document(&self) -> Option<&Value>

The JSON Schema document, when this is a json-schema entry.

pub fn protobuf_message(&self) -> Option<&str>

The protobuf message name, when this is a protobuf entry.

pub fn cdr_fields(&self) -> Option<&Value>

The ordered field list, when this is a cdr entry.

pub fn cdr_types(&self) -> Option<&Map<String, Value>>

The local type table of a cdr entry (absent when the message uses primitives only).

pub fn protobuf_descriptor_set(&self) -> Option<Vec<u8>>

The decoded FileDescriptorSet bytes, when this is a protobuf entry.

Trait Implementations

impl Clone for TypeSchema

fn clone(&self) -> TypeSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TypeSchema

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

Formats the value using the given formatter.

impl Eq for TypeSchema

impl PartialEq for TypeSchema

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TypeSchema