Struct SWHID

#[repr(C)]
pub struct SWHID {
    pub namespace_version: u8,
    pub node_type: NodeType,
    pub hash: [u8; 20],
}

SoftWare Heritage persistent IDentifiers

A SWHID consists of two separate parts, a mandatory core identifier that can point to any software artifact (or “object”) available in the Software Heritage archive, and an optional list of qualifiers that allows to specify the context where the object is meant to be seen and point to a subpart of the object itself.

Reference

• https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html
• Roberto Di Cosmo, Morane Gruenpeter, Stefano Zacchiroli. Identifiers for Digital Objects: the Case of Software Source Code Preservation. In Proceedings of iPRES 2018: 15th International Conference on Digital Preservation, Boston, MA, USA, September 2018, 9 pages.
• Roberto Di Cosmo, Morane Gruenpeter, Stefano Zacchiroli. Referencing Source Code Artifacts: a Separate Concern in Software Citation. In Computing in Science and Engineering, volume 22, issue 2, pages 33-43. ISSN 1521-9615, IEEE. March 2020.

Fields

namespace_version: u8

Namespace Version

node_type: NodeType

Node type

hash: [u8; 20]

SHA1 has of the node

Implementations

impl SWHID

pub const BYTES_SIZE: usize = 22usize

The size of the binary representation of a SWHID

Trait Implementations

impl Clone for SWHID

fn clone(&self) -> SWHID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SWHID

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SWHID

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

Deserialize this value from the given Serde deserializer.

impl Display for SWHID

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

Formats the value using the given formatter.

impl From<SWHID> for [u8; 22]

fn from(value: SWHID) -> Self

Converts to this type from the input type.

impl FromStr for SWHID

type Err = StrSWHIDDeserializationError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for SWHID

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 Ord for SWHID

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SWHID

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

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl RadixKey for SWHID

const LEVELS: usize = 22usize

fn get_level(&self, level: usize) -> u8

impl Serialize for SWHID

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for SWHID

Parse a SWHID from the string representation

type Error = StrSWHIDDeserializationError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 22]> for SWHID

Parse a SWHID from bytes, while the SWHID struct has the exact same layout and thus it can be read directly from bytes, this function is provided for completeness and safety because we can check the namespace version is supported.

type Error = BinSWHIDDeserializationError

The type returned in the event of a conversion error.

fn try_from(value: [u8; 22]) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for SWHID

impl Eq for SWHID

impl StructuralPartialEq for SWHID