Struct Name

pub struct Name {
    pub name: String,
    pub namespace: Option<String>,
    pub aliases: Option<Vec<String>>,
}

Represents names for record, enum and fixed Avro schemas.

Each of these Schemas have a fullname composed of two parts:

• a name
• a namespace

aliases can also be defined, to facilitate schema evolution.

More information about schema names can be found in the Avro specification

Fields

name: String

namespace: Option<String>

aliases: Option<Vec<String>>

Implementations

impl Name

pub fn is_valid(name: &str) -> bool

Reports whether the given string is a valid Avro name.

See: https://avro.apache.org/docs/1.11.1/specification/#names

pub fn validate(name: &str) -> Result<(), AvroError>

Returns an error if the given name is invalid.

pub fn make_valid(name: &str) -> String

Rewrites name to be valid.

Any non alphanumeric characters are replaced with underscores. If the name begins with a number, it is prefixed with _.

make_valid is not injective. Multiple invalid names are mapped to the the same valid name.

pub fn parse(complex: &Map<String, Value>) -> Result<Self, AvroError>

Parse a serde_json::map::Map into a Name.

pub fn parse_simple(name: &str) -> Result<Self, AvroError>

Parses a name from a simple string.

pub fn fullname(&self, default_namespace: &str) -> FullName

Return the fullname of this Name

More information about fullnames can be found in the Avro specification

Trait Implementations

impl Clone for Name

fn clone(&self) -> Name

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Name

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

Formats the value using the given formatter.

impl PartialEq for Name

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