Struct identity_iota::did::verifiable::DocumentSigner

source · [−]

pub struct DocumentSigner<'base, 'query, D = CoreDID, T = BTreeMap<String, Value, Global>, U = BTreeMap<String, Value, Global>, V = BTreeMap<String, Value, Global>> where
    D: DID + KeyComparable,  { /* private fields */ }

Implementations

source

impl<'base, '_, D, T, U, V> DocumentSigner<'base, '_, D, T, U, V> where
D: DID + KeyComparable,

source

pub fn new(
document: &'base CoreDocument<D, T, U, V>,
private: &'base Key<Private>
) -> DocumentSigner<'base, '_, D, T, U, V>

source

pub fn options(
self,
options: ProofOptions
) -> DocumentSigner<'base, '_, D, T, U, V>

Overwrites the ProofOptions.

source

pub fn created(
self,
created: Timestamp
) -> DocumentSigner<'base, '_, D, T, U, V>

Sets the Proof::created field.

source

pub fn expires(
self,
expires: Timestamp
) -> DocumentSigner<'base, '_, D, T, U, V>

Sets the Proof::expires field. The signature will fail validation after the specified datetime.

source

pub fn challenge(
self,
challenge: String
) -> DocumentSigner<'base, '_, D, T, U, V>

Sets the Proof::challenge field.

source

pub fn domain(self, domain: String) -> DocumentSigner<'base, '_, D, T, U, V>

Sets the Proof::domain field.

source

pub fn purpose(
self,
purpose: ProofPurpose
) -> DocumentSigner<'base, '_, D, T, U, V>

Sets the Proof::purpose field.

source

impl<'base, 'query, D, T, U, V> DocumentSigner<'base, 'query, D, T, U, V> where
D: DID + KeyComparable,

source

pub fn method<Q>(self, value: Q) -> DocumentSigner<'base, 'query, D, T, U, V> where
Q: Into<DIDUrlQuery<'query>>,

source

impl<'_, '_, D, T, U, V> DocumentSigner<'_, '_, D, T, U, V> where
D: DID + KeyComparable,

source

pub fn sign<X>(&self, that: &mut X) -> Result<(), Error> where
X: Serialize + SetSignature + TryMethod,

Signs the provided data with the configured verification method.

Errors

Fails if an unsupported verification method is used, document serialization fails, or the signature operation fails.

Auto Trait Implementations

impl<'base, 'query, D, T, U, V> RefUnwindSafe for DocumentSigner<'base, 'query, D, T, U, V> where
 D: RefUnwindSafe,
 T: RefUnwindSafe,
 U: RefUnwindSafe,
 V: RefUnwindSafe,

impl<'base, 'query, D, T, U, V> Send for DocumentSigner<'base, 'query, D, T, U, V> where
 D: Sync,
 T: Sync,
 U: Sync,
 V: Sync,

impl<'base, 'query, D, T, U, V> Sync for DocumentSigner<'base, 'query, D, T, U, V> where
 D: Sync,
 T: Sync,
 U: Sync,
 V: Sync,

impl<'base, 'query, D, T, U, V> Unpin for DocumentSigner<'base, 'query, D, T, U, V>

impl<'base, 'query, D, T, U, V> UnwindSafe for DocumentSigner<'base, 'query, D, T, U, V> where
 D: RefUnwindSafe,
 T: RefUnwindSafe,
 U: RefUnwindSafe,
 V: RefUnwindSafe,

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> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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, 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

Struct identity_iota::did::verifiable::DocumentSigner

Implementations

impl<'base, '_, D, T, U, V> DocumentSigner<'base, '_, D, T, U, V> where D: DID + KeyComparable,

pub fn new( document: &'base CoreDocument<D, T, U, V>, private: &'base Key<Private>) -> DocumentSigner<'base, '_, D, T, U, V>

pub fn options( self, options: ProofOptions) -> DocumentSigner<'base, '_, D, T, U, V>

pub fn created( self, created: Timestamp) -> DocumentSigner<'base, '_, D, T, U, V>

pub fn expires( self, expires: Timestamp) -> DocumentSigner<'base, '_, D, T, U, V>

pub fn challenge( self, challenge: String) -> DocumentSigner<'base, '_, D, T, U, V>

pub fn domain(self, domain: String) -> DocumentSigner<'base, '_, D, T, U, V>

pub fn purpose( self, purpose: ProofPurpose) -> DocumentSigner<'base, '_, D, T, U, V>

impl<'base, 'query, D, T, U, V> DocumentSigner<'base, 'query, D, T, U, V> where D: DID + KeyComparable,

pub fn method<Q>(self, value: Q) -> DocumentSigner<'base, 'query, D, T, U, V> where Q: Into<DIDUrlQuery<'query>>,

impl<'_, '_, D, T, U, V> DocumentSigner<'_, '_, D, T, U, V> where D: DID + KeyComparable,

pub fn sign<X>(&self, that: &mut X) -> Result<(), Error> where X: Serialize + SetSignature + TryMethod,

Errors

Auto Trait Implementations

impl<'base, 'query, D, T, U, V> RefUnwindSafe for DocumentSigner<'base, 'query, D, T, U, V> where D: RefUnwindSafe, T: RefUnwindSafe, U: RefUnwindSafe, V: RefUnwindSafe,

impl<'base, 'query, D, T, U, V> Send for DocumentSigner<'base, 'query, D, T, U, V> where D: Sync, T: Sync, U: Sync, V: Sync,

impl<'base, 'query, D, T, U, V> Sync for DocumentSigner<'base, 'query, D, T, U, V> where D: Sync, T: Sync, U: Sync, V: Sync,

impl<'base, 'query, D, T, U, V> Unpin for DocumentSigner<'base, 'query, D, T, U, V>

impl<'base, 'query, D, T, U, V> UnwindSafe for DocumentSigner<'base, 'query, D, T, U, V> where D: RefUnwindSafe, T: RefUnwindSafe, U: RefUnwindSafe, V: RefUnwindSafe,

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> From<T> for T

fn from(t: T) -> T

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, 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

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

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<'base, '_, D, T, U, V> DocumentSigner<'base, '_, D, T, U, V> where
D: DID + KeyComparable,

pub fn new(
document: &'base CoreDocument<D, T, U, V>,
private: &'base Key<Private>
) -> DocumentSigner<'base, '_, D, T, U, V>

pub fn options(
self,
options: ProofOptions
) -> DocumentSigner<'base, '_, D, T, U, V>

pub fn created(
self,
created: Timestamp
) -> DocumentSigner<'base, '_, D, T, U, V>

pub fn expires(
self,
expires: Timestamp
) -> DocumentSigner<'base, '_, D, T, U, V>

pub fn challenge(
self,
challenge: String
) -> DocumentSigner<'base, '_, D, T, U, V>

pub fn purpose(
self,
purpose: ProofPurpose
) -> DocumentSigner<'base, '_, D, T, U, V>

impl<'base, 'query, D, T, U, V> DocumentSigner<'base, 'query, D, T, U, V> where
D: DID + KeyComparable,

pub fn method<Q>(self, value: Q) -> DocumentSigner<'base, 'query, D, T, U, V> where
Q: Into<DIDUrlQuery<'query>>,

impl<'_, '_, D, T, U, V> DocumentSigner<'_, '_, D, T, U, V> where
D: DID + KeyComparable,

pub fn sign<X>(&self, that: &mut X) -> Result<(), Error> where
X: Serialize + SetSignature + TryMethod,

impl<'base, 'query, D, T, U, V> RefUnwindSafe for DocumentSigner<'base, 'query, D, T, U, V> where
D: RefUnwindSafe,
T: RefUnwindSafe,
U: RefUnwindSafe,
V: RefUnwindSafe,

impl<'base, 'query, D, T, U, V> Send for DocumentSigner<'base, 'query, D, T, U, V> where
D: Sync,
T: Sync,
U: Sync,
V: Sync,

impl<'base, 'query, D, T, U, V> Sync for DocumentSigner<'base, 'query, D, T, U, V> where
D: Sync,
T: Sync,
U: Sync,
V: Sync,

impl<'base, 'query, D, T, U, V> UnwindSafe for DocumentSigner<'base, 'query, D, T, U, V> where
D: RefUnwindSafe,
T: RefUnwindSafe,
U: RefUnwindSafe,
V: RefUnwindSafe,

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, U> Into<U> for T where
U: From<T>,

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>,