Struct InstanceSpec

#[non_exhaustive]
pub struct InstanceSpec {
    pub id: InstanceId,
    pub name: String,
    pub artifact: ArtifactId,
}

Exhaustive service instance specification.

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.

id: InstanceId

Unique numeric ID of the service instance.

Exonum assigns an ID to the service on instantiation. It is mainly used to route transaction messages belonging to this instance.

name: String

Unique name of the service instance.

The name serves as a primary identifier of this service in most operations. It is assigned by the network administrators.

The name must correspond to the following regular expression: [a-zA-Z0-9/\:-_]+.

artifact: ArtifactId

Identifier of the corresponding artifact.

Implementations

impl InstanceSpec

pub fn new( id: InstanceId, name: impl Into<String>, artifact: impl AsRef<str>, ) -> Result<Self>

Creates a new instance specification or return an error if the resulting specification is not correct.

pub fn from_raw_parts( id: InstanceId, name: String, artifact: ArtifactId, ) -> Self

Creates a new instance specification from prepared parts without any checks.

pub fn is_valid_name(name: impl AsRef<str>) -> Result<()>

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

pub fn as_descriptor(&self) -> InstanceDescriptor

Returns the corresponding descriptor of this instance specification.

Trait Implementations

impl BinaryValue for InstanceSpec

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 InstanceSpec

fn clone(&self) -> InstanceSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstanceSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InstanceSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for InstanceSpec

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

Formats the value using the given formatter.

impl From<InstanceSpec> for InstanceInitParams

fn from(instance_spec: InstanceSpec) -> Self

Converts to this type from the input type.

impl Hash for InstanceSpec

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 ObjectHash for InstanceSpec

fn object_hash(&self) -> Hash

Returns a hash of the value.

impl PartialEq for InstanceSpec

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

type ProtoStruct = InstanceSpec

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 InstanceSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ValidateInput for InstanceSpec

type Error = Error

The type returned in the event of a validate error.

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

Perform parameters validation for this configuration and return error if value is inconsistent.

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

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

impl Eq for InstanceSpec

impl StructuralPartialEq for InstanceSpec