AvroSchema

Struct AvroSchema 

Source
pub struct AvroSchema {
    pub json_string: String,
}
Expand description

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

Fields§

§json_string: String

The Avro schema as a JSON string.

Implementations§

Source§

impl AvroSchema

Source

pub fn new(json_string: String) -> Self

Creates a new AvroSchema from a JSON string.

Source

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

Source

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:

Note: FingerprintAlgorithm::None 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, load or set the Fingerprint::Id directly via Fingerprint::load_fingerprint_id or SchemaStore::set.

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::None.

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

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

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

Source

pub fn generate_fingerprint_rabin( schema: &Schema<'_>, ) -> Result<Fingerprint, ArrowError>

Generates the 64-bit Rabin fingerprint for the given Schema.

The fingerprint is computed from the canonical form of the schema. This is also known as CRC-64-AVRO.

§Returns

A Fingerprint::Rabin variant containing the 64-bit fingerprint.

Source

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

Source

pub fn from_arrow_with_options( schema: &ArrowSchema, null_order: Option<Nullability>, ) -> Result<AvroSchema, ArrowError>

Build Avro JSON from an Arrow [ArrowSchema], applying the given null‑union order.

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§

Source§

impl Clone for AvroSchema

Source§

fn clone(&self) -> AvroSchema

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AvroSchema

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for AvroSchema

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for AvroSchema

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<&Schema> for AvroSchema

Source§

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().

Source§

type Error = ArrowError

The type returned in the event of a conversion error.
Source§

impl Eq for AvroSchema

Source§

impl StructuralPartialEq for AvroSchema

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,