Struct exonum::runtime::ArtifactId

#[non_exhaustive]pub struct ArtifactId {
    pub runtime_id: u32,
    pub name: String,
    pub version: Version,
}

The artifact identifier is required to construct service instances. In other words, an artifact identifier is similar to a class name, and a specific service instance is similar to a class instance.

An artifact ID has the following string representation:

{runtime_id}:{artifact_name}:{version}

where:

• runtime_id is a runtime identifier,
• artifact_name is the name of the artifact
• version is the artifact semantic version

Artifact name may contain the following characters: a-zA-Z0-9 and _.-.

Examples

// Typical Rust artifact.
let rust_artifact_id = "0:my-service:1.0.0".parse::<ArtifactId>()?;
// Typical Java artifact.
let java_artifact_id = "1:com.exonum.service:1.0.0".parse::<ArtifactId>()?;

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

runtime_id: u32

Runtime identifier.

name: String

Artifact name.

version: Version

Semantic version of the artifact.

Methods

impl ArtifactId

pub fn new(
    runtime_id: impl Into<u32>,
    name: impl Into<String>,
    version: Version
) -> Result<Self>

Creates a new artifact identifier from the given runtime id and name or returns error if the resulting artifact id is not correct.

pub fn from_raw_parts(runtime_id: u32, name: String, version: Version) -> Self

Creates a new artifact identifier from prepared parts without any checks.

Use this method only if you don't need an artifact verification (e.g. in tests).

Stability

Since the internal structure of ArtifactId can change, this method is considered unstable and can break in the future.

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

Checks if the specified artifact is an upgraded version of another artifact.

pub fn into_default_instance(
    self,
    id: InstanceId,
    name: impl Into<String>
) -> InstanceInitParams

Converts into InstanceInitParams with the given IDs and an empty constructor.

Trait Implementations

impl BinaryKey for ArtifactId

fn size(&self) -> usize

Returns the size of the serialized key in bytes.

fn write(&self, buffer: &mut [u8]) -> usize

Serializes the key into the specified buffer of bytes.

fn read(buffer: &[u8]) -> Self::Owned

Deserializes the key from the specified buffer of bytes.

impl BinaryValue for ArtifactId

fn to_bytes(&self) -> Vec<u8>

Serializes the given value to the vector of bytes.

fn from_bytes(value: Cow<[u8]>) -> Result<Self, Error>

Deserializes the value from the given bytes array.

fn into_bytes(self) -> Vec<u8>

Consumes and serializes the given value to the vector of bytes. This method is faster with the wrapped values, thus if you wouldn't use value after serialization use it.

impl Clone for ArtifactId

fn clone(&self) -> ArtifactId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArtifactId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ArtifactId

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

Deserialize this value from the given Serde deserializer.

impl Display for ArtifactId

fn fmt(&self, formatter: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for ArtifactId

impl FromStr for ArtifactId

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for ArtifactId

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, 

Feeds a slice of this type into the given [Hasher].

impl ObjectHash for ArtifactId

fn object_hash(&self) -> Hash

Returns a hash of the value.

impl Ord for ArtifactId

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ArtifactId> for ArtifactId

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<ArtifactId> for ArtifactId

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl ProtobufConvert for ArtifactId

type ProtoStruct = ArtifactId

Type generated from the Protobuf definition.

fn from_pb(pb: Self::ProtoStruct) -> Result<Self, Error>

Performs conversion from the type generated from Protobuf.

fn to_pb(&self) -> Self::ProtoStruct

Performs conversion to the type generated from Protobuf.

impl Serialize for ArtifactId

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

Serialize this value into the given Serde serializer.

impl StructuralEq for ArtifactId

impl StructuralPartialEq for ArtifactId

impl ValidateInput for ArtifactId

type Error = Error

The type returned in the event of a validate error.

fn validate(&self) -> Result<(), Self::Error>

Checks that the artifact name contains only allowed characters and is not empty.

fn into_validated(self) -> Result<Self, Self::Error>

The same as validate method, but returns the value itself as a successful result.