Struct AvroSchema 

pub struct AvroSchema {
    pub json_string: String,
}

A wrapper for an Avro schema in its JSON string representation.

Fields

json_string: String

The Avro schema as a JSON string.

Implementations

impl AvroSchema

pub fn new(json_string: String) -> Self

Creates a new AvroSchema from a JSON string.

pub(crate) fn schema(&self) -> Result<Schema<'_>, ArrowError>

pub fn fingerprint( &self, hash_type: FingerprintAlgorithm, ) -> Result<Fingerprint, ArrowError>

Returns the fingerprint of the schema, computed using the specified FingerprintAlgorithm.

The fingerprint is computed over the schema’s Parsed Canonical Form as defined by the Avro specification. Depending on hash_type, this will return one of the supported Fingerprint variants:

• Fingerprint::Rabin for FingerprintAlgorithm::Rabin
• Fingerprint::MD5 for FingerprintAlgorithm::MD5
• Fingerprint::SHA256 for FingerprintAlgorithm::SHA256

Note: FingerprintAlgorithm::Id or FingerprintAlgorithm::Id64 cannot be used to generate a fingerprint and will result in an error. If you intend to use a Schema Registry ID-based wire format, either use SchemaStore::set or load the Fingerprint::Id directly via Fingerprint::load_fingerprint_id or for Fingerprint::Id64 via Fingerprint::load_fingerprint_id64.

See also: https://avro.apache.org/docs/1.11.1/specification/#schema-fingerprints

Errors

Returns an error if deserializing the schema fails, if generating the canonical form of the schema fails, or if hash_type is FingerprintAlgorithm::Id.

Examples

use arrow_avro::schema::{AvroSchema, FingerprintAlgorithm};

let avro = AvroSchema::new("\"string\"".to_string());
let fp = avro.fingerprint(FingerprintAlgorithm::Rabin).unwrap();

pub(crate) fn generate_fingerprint( schema: &Schema<'_>, hash_type: FingerprintAlgorithm, ) -> Result<Fingerprint, ArrowError>

pub(crate) fn generate_canonical_form( schema: &Schema<'_>, ) -> Result<String, ArrowError>

Generates the Parsed Canonical Form for the given Schema.

The canonical form is a standardized JSON representation of the schema, primarily used for generating a schema fingerprint for equality checking.

This form strips attributes that do not affect the schema’s identity, such as doc fields, aliases, and any properties not defined in the Avro specification.

https://avro.apache.org/docs/1.11.1/specification/#parsing-canonical-form-for-schemas

pub(crate) fn from_arrow_with_options( schema: &ArrowSchema, options: Option<AvroSchemaOptions>, ) -> Result<AvroSchema, ArrowError>

Build Avro JSON from an Arrow [ArrowSchema], applying the given null‑union order and optionally stripping internal Arrow metadata.

If the input Arrow schema already contains Avro JSON in SCHEMA_METADATA_KEY, that JSON is returned verbatim to preserve the exact header encoding alignment; otherwise, a new JSON is generated honoring null_union_order at all nullable sites.

Trait Implementations

impl Clone for AvroSchema

fn clone(&self) -> AvroSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AvroSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AvroSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AvroSchema

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Schema> for AvroSchema

fn try_from(schema: &ArrowSchema) -> Result<Self, Self::Error>

Converts an ArrowSchema to AvroSchema, delegating to AvroSchema::from_arrow_with_options with None so that the union null ordering is decided by Nullability::default().

type Error = ArrowError

The type returned in the event of a conversion error.

impl Eq for AvroSchema

impl StructuralPartialEq for AvroSchema