pub struct IdentityClientReadOnly { /* private fields */ }
Expand description
An [IotaClient
] enriched with identity-related
functionalities.
Implementations§
Source§impl IdentityClientReadOnly
impl IdentityClientReadOnly
Sourcepub fn package_id(&self) -> ObjectID
pub fn package_id(&self) -> ObjectID
Returns iota_identity
’s package ID.
The ID of the packages depends on the network
the client is connected to.
Sourcepub const fn network(&self) -> &NetworkName
pub const fn network(&self) -> &NetworkName
Returns the name of the network the client is currently connected to.
Sourcepub fn chain_id(&self) -> &str
pub fn chain_id(&self) -> &str
Returns the chain identifier for the network this client is connected to. This method differs from IdentityClientReadOnly::network as it doesn’t return the human-readable network ID when available.
Sourcepub async fn new(
iota_client: IotaClient,
) -> Result<IdentityClientReadOnly, Error>
pub async fn new( iota_client: IotaClient, ) -> Result<IdentityClientReadOnly, Error>
Attempts to create a new IdentityClientReadOnly
from a given [IotaClient
].
§Failures
This function fails if the provided iota_client
is connected to an unrecognized
network.
§Notes
When trying to connect to a local or unofficial network, prefer using
IdentityClientReadOnly::new_with_pkg_id
.
Sourcepub async fn new_with_pkg_id(
iota_client: IotaClient,
package_id: ObjectID,
) -> Result<IdentityClientReadOnly, Error>
pub async fn new_with_pkg_id( iota_client: IotaClient, package_id: ObjectID, ) -> Result<IdentityClientReadOnly, Error>
Attempts to create a new IdentityClientReadOnly
from the given IOTA client
and the ID of the IotaIdentity package published on the network the client is
connected to.
Sourcepub fn set_migration_registry_id(&mut self, id: ObjectID)
pub fn set_migration_registry_id(&mut self, id: ObjectID)
Sets the migration registry ID for the current network.
§Notes
This is only needed when automatic retrival of MigrationRegistry’s ID fails.
Sourcepub async fn resolve_did(&self, did: &IotaDID) -> Result<IotaDocument, Error>
pub async fn resolve_did(&self, did: &IotaDID) -> Result<IotaDocument, Error>
Queries an IotaDocument
DID Document through its did
.
Trait Implementations§
Source§impl Clone for IdentityClientReadOnly
impl Clone for IdentityClientReadOnly
Source§fn clone(&self) -> IdentityClientReadOnly
fn clone(&self) -> IdentityClientReadOnly
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl CoreClientReadOnly for IdentityClientReadOnly
impl CoreClientReadOnly for IdentityClientReadOnly
Source§fn package_id(&self) -> ObjectID
fn package_id(&self) -> ObjectID
Source§fn network_name(&self) -> &NetworkName
fn network_name(&self) -> &NetworkName
Source§fn client_adapter(&self) -> &IotaClientRustSdk
fn client_adapter(&self) -> &IotaClientRustSdk
IotaClientAdapter
] used by this client. Read moreSource§fn package_history(&self) -> Vec<ObjectID>
fn package_history(&self) -> Vec<ObjectID>
§fn get_object_by_id<'life0, 'async_trait, T>(
&'life0 self,
object_id: ObjectID,
) -> Pin<Box<dyn Future<Output = Result<T, Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
T: 'async_trait + DeserializeOwned,
Self: Sync + 'async_trait,
fn get_object_by_id<'life0, 'async_trait, T>(
&'life0 self,
object_id: ObjectID,
) -> Pin<Box<dyn Future<Output = Result<T, Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
T: 'async_trait + DeserializeOwned,
Self: Sync + 'async_trait,
§fn get_object_ref_by_id<'life0, 'async_trait>(
&'life0 self,
object_id: ObjectID,
) -> Pin<Box<dyn Future<Output = Result<Option<OwnedObjectRef>, Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
Self: Sync + 'async_trait,
fn get_object_ref_by_id<'life0, 'async_trait>(
&'life0 self,
object_id: ObjectID,
) -> Pin<Box<dyn Future<Output = Result<Option<OwnedObjectRef>, Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
Self: Sync + 'async_trait,
OwnedObjectRef
], if any. Read more§fn find_object_for_address<'life0, 'async_trait, T, P>(
&'life0 self,
address: IotaAddress,
predicate: P,
) -> Pin<Box<dyn Future<Output = Result<Option<T>, Error>> + Send + 'async_trait>>
fn find_object_for_address<'life0, 'async_trait, T, P>( &'life0 self, address: IotaAddress, predicate: P, ) -> Pin<Box<dyn Future<Output = Result<Option<T>, Error>> + Send + 'async_trait>>
§fn get_iota_coins_with_at_least_balance<'life0, 'async_trait>(
&'life0 self,
owner: IotaAddress,
balance: u64,
) -> Pin<Box<dyn Future<Output = Result<Vec<(ObjectID, SequenceNumber, ObjectDigest)>, Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
Self: Sync + 'async_trait,
fn get_iota_coins_with_at_least_balance<'life0, 'async_trait>(
&'life0 self,
owner: IotaAddress,
balance: u64,
) -> Pin<Box<dyn Future<Output = Result<Vec<(ObjectID, SequenceNumber, ObjectDigest)>, Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
Self: Sync + 'async_trait,
balance
. Read more§fn find_owned_ref_for_address<'life0, 'async_trait, P>(
&'life0 self,
address: IotaAddress,
tag: StructTag,
predicate: P,
) -> Pin<Box<dyn Future<Output = Result<Option<(ObjectID, SequenceNumber, ObjectDigest)>, Error>> + Send + 'async_trait>>
fn find_owned_ref_for_address<'life0, 'async_trait, P>( &'life0 self, address: IotaAddress, tag: StructTag, predicate: P, ) -> Pin<Box<dyn Future<Output = Result<Option<(ObjectID, SequenceNumber, ObjectDigest)>, Error>> + Send + 'async_trait>>
tag
and for which predicate
returns true
.Source§impl Deref for IdentityClientReadOnly
impl Deref for IdentityClientReadOnly
Source§impl DidResolutionHandler for IdentityClientReadOnly
impl DidResolutionHandler for IdentityClientReadOnly
Source§fn resolve_did<'life0, 'life1, 'async_trait>(
&'life0 self,
did: &'life1 IotaDID,
) -> Pin<Box<dyn Future<Output = Result<IotaDocument, Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
IdentityClientReadOnly: 'async_trait,
fn resolve_did<'life0, 'life1, 'async_trait>(
&'life0 self,
did: &'life1 IotaDID,
) -> Pin<Box<dyn Future<Output = Result<IotaDocument, Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
IdentityClientReadOnly: 'async_trait,
IotaDocument
. Returns an empty, deactivated document if the state metadata
of the identity is empty. Read moreAuto Trait Implementations§
impl Freeze for IdentityClientReadOnly
impl !RefUnwindSafe for IdentityClientReadOnly
impl Send for IdentityClientReadOnly
impl Sync for IdentityClientReadOnly
impl Unpin for IdentityClientReadOnly
impl !UnwindSafe for IdentityClientReadOnly
Blanket Implementations§
§impl<U> As for U
impl<U> As for U
§fn as_<T>(self) -> Twhere
T: CastFrom<U>,
fn as_<T>(self) -> Twhere
T: CastFrom<U>,
self
to type T
. The semantics of numeric casting with the as
operator are followed, so <T as As>::as_::<U>
can be used in the same way as T as U
for numeric conversions. Read more§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> ConvertTo<T> for Twhere
T: Send,
impl<T> ConvertTo<T> for Twhere
T: Send,
fn convert(self) -> Result<T, Error>
fn convert_unchecked(self) -> T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a Request
Source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.