Struct ModuleDescriptor 

pub struct ModuleDescriptor { /* private fields */ }

A data structure that uniquely identifies an exact instance of a module

If two modules have the same ModuleDescriptor, they are considered to be the same module

The uid field encodes particulars about a module so it will never be mistaken for another copy or variation of the module even if the version field is the same. For example, a module loaded from the file system will use the uid to hash the path, while a module fetched from git will hash the url and branch.

Implementations

impl ModuleDescriptor

pub fn new(name: String, version: Option<Version>, uid: Option<u64>) -> Self

Create a new ModuleDescriptor

pub fn new_with_ident_bytes_and_fmt_id( name: String, version: Option<Version>, ident: &[u8], fmt_id: u64, ) -> Self

Returns a new ModuleDescriptor by computing a stable hash of the ident bytes, and using the fmt_id

pub fn new_with_path_and_fmt_id( name: String, version: Option<Version>, path: &Path, fmt_id: u64, ) -> Self

Create a new ModuleDescriptor using a file system path and another unique id

The descriptor’s uid is based on a stable-hash of the path, because a module loaded by path shouldn’t be substituted for any other module unless it’s from the same path.

The purpose of the fmt_id is to ensure two different formats or catalogs don’t generate the same ModuleDescriptor, but you can pass 0 if it doesn’t matter

pub fn name(&self) -> &str

Returns the name of the module represented by the ModuleDescriptor

pub fn uid(&self) -> Option<u64>

Returns the uid associated with the ModuleDescriptor

pub fn version(&self) -> Option<&Version>

Returns the version of the module represented by the ModuleDescriptor

pub fn hash(&self) -> u64

Internal. Use the Hash trait to get a uid for the whole ModuleDescriptor

pub fn uid_from_ident_bytes_and_fmt_id(ident: &[u8], fmt_id: u64) -> u64

Returns a uid based on a stable hash of the ident bytes, and the fmt_id

Trait Implementations

impl Clone for ModuleDescriptor

fn clone(&self) -> ModuleDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModuleDescriptor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ModuleDescriptor

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

Formats the value using the given formatter.

impl Hash for ModuleDescriptor

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 PartialEq for ModuleDescriptor

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ModuleDescriptor

impl StructuralPartialEq for ModuleDescriptor