Struct identity_iota::client::DiffChain

source · [−]

pub struct DiffChain { /* private fields */ }

👎 Deprecated since 0.5.0:

diff chain features are slated for removal

Implementations

source

impl DiffChain

source

pub async fn try_from_messages(
 integration_chain: &IntegrationChain,
 messages: &[Message],
 client: &Client
) -> Result<DiffChain, Error>

Constructs a new DiffChain for the given IntegrationChain from a slice of Messages.

source

pub async fn try_from_index(
 integration_chain: &IntegrationChain,
 index: MessageIndex<DiffMessage>,
 client: &Client
) -> Result<DiffChain, Error>

Constructs a new DiffChain for the given IntegrationChain from the given MessageIndex.

source

pub fn new() -> DiffChain

Creates a new DiffChain.

source

pub fn len(&self) -> usize

Returns the total number of diffs.

source

pub fn is_empty(&self) -> bool

Returns true if the DiffChain is empty.

source

pub fn clear(&mut self)

Empties the DiffChain, removing all diffs.

source

pub fn iter(&self) -> Iter<'_, DiffMessage>

Returns an iterator yielding references to DiffMessages.

source

pub fn current_message_id(&self) -> Option<&MessageId>

Returns the MessageId of the latest diff in the chain, if any.

source

pub fn try_push_and_merge(
 &mut self,
 diff: DiffMessage,
 integration_document: &ResolvedIotaDocument
) -> Result<ResolvedIotaDocument, Error>

Adds a new diff to the DiffChain while merging it with the given integration document. Returns the merged document if valid.

Errors

Fails if the diff signature is invalid, the Tangle message references within the diff are invalid, or the merge fails.

source

pub fn verify_diff(
 diff: &DiffMessage,
 document: &ResolvedIotaDocument,
 expected_prev_message_id: &MessageId
) -> Result<(), Error>

Checks whether the DiffMessage attributes and signature are valid.

NOTE: does not verify the changes contained in the diff are valid. See DiffChain::try_merge.

source

pub fn try_merge(
diff: &DiffMessage,
document: &ResolvedIotaDocument
) -> Result<ResolvedIotaDocument, Error>

Attempts to merge the DiffMessage changes into the given document and returns the resulting ResolvedIotaDocument if valid.

NOTE: does not verify the signature and attributes. See DiffChain::verify_diff.

source

pub fn check_valid_addition(
 diff: &DiffMessage,
 document: &ResolvedIotaDocument,
 expected_prev_message_id: &MessageId
) -> Result<ResolvedIotaDocument, Error>

Checks if the DiffMessage can be added to the DiffChain. Returns the merged document if valid.

Equivalent to calling DiffChain::verify_diff then DiffChain::try_merge.

Errors

Fails if the DiffMessage is not a valid addition.

Trait Implementations

source

impl Clone for DiffChain

source

fn clone(&self) -> DiffChain

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for DiffChain

source

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

Formats the value using the given formatter. Read more

source

impl Default for DiffChain

source

fn default() -> DiffChain

Returns the “default value” for a type. Read more

source

impl<'de> Deserialize<'de> for DiffChain

source

fn deserialize<D>(
deserializer: D
) -> Result<DiffChain, <D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl Display for DiffChain

source

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

Formats the value using the given formatter. Read more

source

impl From<DiffChain> for Vec<DiffMessage, Global>

source

fn from(diff_chain: DiffChain) -> Vec<DiffMessage, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Converts to this type from the input type.

source

impl Serialize for DiffChain

source

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

impl RefUnwindSafe for DiffChain

impl Send for DiffChain

impl Sync for DiffChain

impl Unpin for DiffChain

impl UnwindSafe for DiffChain

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> FmtJson for T where
T: ToJson,

source

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

Format this as a JSON string or pretty-JSON string based on whether the # format flag was used. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> FromJson for T where
T: for<'de> Deserialize<'de>,

source

fn from_json(json: &impl AsRef<str>) -> Result<Self, Error>

Deserialize Self from a string of JSON text.

source

fn from_json_slice(json: &impl AsRef<[u8]>) -> Result<Self, Error>

Deserialize Self from bytes of JSON text.

source

fn from_json_value(json: Value) -> Result<Self, Error>

Deserialize Self from a [serde_json::Value].

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToJson for T where
T: Serialize,

source

fn to_json(&self) -> Result<String, Error>

Serialize self as a string of JSON.

source

fn to_json_vec(&self) -> Result<Vec<u8, Global>, Error>

Serialize self as a JSON byte vector.

source

fn to_json_value(&self) -> Result<Value, Error>

Serialize self as a [serde_json::Value].

source

fn to_json_pretty(&self) -> Result<String, Error>

Serialize self as a pretty-printed string of JSON.

source

fn to_jcs(&self) -> Result<Vec<u8, Global>, Error>

Serialize self as a JSON byte vector, normalized using JSON Canonicalization Scheme (JCS). Read more

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

source

Struct identity_iota::client::DiffChain

Implementations

impl DiffChain

pub async fn try_from_messages( integration_chain: &IntegrationChain, messages: &[Message], client: &Client) -> Result<DiffChain, Error>

pub async fn try_from_index( integration_chain: &IntegrationChain, index: MessageIndex<DiffMessage>, client: &Client) -> Result<DiffChain, Error>

pub fn new() -> DiffChain

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn clear(&mut self)

pub fn iter(&self) -> Iter<'_, DiffMessage>

pub fn current_message_id(&self) -> Option<&MessageId>

pub fn try_push_and_merge( &mut self, diff: DiffMessage, integration_document: &ResolvedIotaDocument) -> Result<ResolvedIotaDocument, Error>

pub fn verify_diff( diff: &DiffMessage, document: &ResolvedIotaDocument, expected_prev_message_id: &MessageId) -> Result<(), Error>

pub fn try_merge( diff: &DiffMessage, document: &ResolvedIotaDocument) -> Result<ResolvedIotaDocument, Error>

pub fn check_valid_addition( diff: &DiffMessage, document: &ResolvedIotaDocument, expected_prev_message_id: &MessageId) -> Result<ResolvedIotaDocument, Error>

Trait Implementations

impl Clone for DiffChain

fn clone(&self) -> DiffChain

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

impl Debug for DiffChain

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

impl Default for DiffChain

fn default() -> DiffChain

impl<'de> Deserialize<'de> for DiffChain

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

impl Display for DiffChain

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

impl From<DiffChain> for Vec<DiffMessage, Global>

fn from(diff_chain: DiffChain) -> Vec<DiffMessage, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

impl Serialize for DiffChain

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

Auto Trait Implementations

impl RefUnwindSafe for DiffChain

impl Send for DiffChain

impl Sync for DiffChain

impl Unpin for DiffChain

impl UnwindSafe for DiffChain

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> FmtJson for T where T: ToJson,

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FromJson for T where T: for<'de> Deserialize<'de>,

fn from_json(json: &impl AsRef<str>) -> Result<Self, Error>

fn from_json_slice(json: &impl AsRef<[u8]>) -> Result<Self, Error>

fn from_json_value(json: Value) -> Result<Self, Error>

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToJson for T where T: Serialize,

fn to_json(&self) -> Result<String, Error>

fn to_json_vec(&self) -> Result<Vec<u8, Global>, Error>

fn to_json_value(&self) -> Result<Value, Error>

fn to_json_pretty(&self) -> Result<String, Error>

fn to_jcs(&self) -> Result<Vec<u8, Global>, Error>

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T> ToString for T where T: Display + ?Sized,

default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

pub async fn try_from_messages(
integration_chain: &IntegrationChain,
messages: &[Message],
client: &Client
) -> Result<DiffChain, Error>

pub async fn try_from_index(
integration_chain: &IntegrationChain,
index: MessageIndex<DiffMessage>,
client: &Client
) -> Result<DiffChain, Error>

pub fn try_push_and_merge(
&mut self,
diff: DiffMessage,
integration_document: &ResolvedIotaDocument
) -> Result<ResolvedIotaDocument, Error>

pub fn verify_diff(
diff: &DiffMessage,
document: &ResolvedIotaDocument,
expected_prev_message_id: &MessageId
) -> Result<(), Error>

pub fn try_merge(
diff: &DiffMessage,
document: &ResolvedIotaDocument
) -> Result<ResolvedIotaDocument, Error>

pub fn check_valid_addition(
diff: &DiffMessage,
document: &ResolvedIotaDocument,
expected_prev_message_id: &MessageId
) -> Result<ResolvedIotaDocument, Error>

fn deserialize<D>(
deserializer: D
) -> Result<DiffChain, <D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,

fn from(diff_chain: DiffChain) -> Vec<DiffMessage, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> FmtJson for T where
T: ToJson,

impl<T> FromJson for T where
T: for<'de> Deserialize<'de>,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToJson for T where
T: Serialize,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,