Struct FQName 

pub struct FQName {
    pub package_path: Path,
    pub module_path: Path,
    pub local_name: Name,
}

FQName represents a Fully Qualified Name (PackagePath + ModulePath + LocalName).

The wire form is the canonical string package/path:module/path#local-name; the reader also accepts the legacy three-element array [package, module, local], where the two paths are legacy arrays of legacy names. schemars is told the schema is a string because that is what the writer emits and what every schema consumer expects.

Fields

package_path: Path

module_path: Path

local_name: Name

Implementations

impl FQName

pub fn new(package_path: Path, module_path: Path, local_name: Name) -> Self

pub fn parse(s: &str) -> Option<Self>

Parse FQName from classic format: pkg:mod:local

pub fn to_canonical_string(&self) -> String

Convert to V4 canonical string format: package/path:module/path#local-name

pub fn from_canonical_string(s: &str) -> Result<Self, String>

Parse from V4 canonical string format: package/path:module/path#local-name

Trait Implementations

impl Clone for FQName

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 FQName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FQName

Reads a fully qualified name from the canonical string or the legacy three-element array.

This is written out rather than derived through #[serde(try_from = "String")] for two reasons. A derived try_from only ever sees a string, so the legacy array [[["morphir"], ["s","d","k"]], [["list"]], ["map"]] — the spelling every classic document uses — could not be read at all. And its error is a bare String, so the code and the cursor are lost by the time serde hands it back; the refusals below carry a Diagnostic through DiagnosticError instead.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FQName

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

Formats the value using the given formatter.

impl Eq for FQName

impl From<FQName> for String

fn from(fqname: FQName) -> String

Converts to this type from the input type.

impl Hash for FQName

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for FQName

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for FQName

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FQName

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 FQName

impl TryFrom<String> for FQName

type Error = String

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.