Struct ironoxide::common::DeviceContext
source · pub struct DeviceContext { /* private fields */ }
Expand description
Signing and encryption key pairs and metadata for a device.
Required to initialize the SDK with a set of device keys (see ironoxide::initialize).
Can be generated by calling generate_new_device and
passing the result to DeviceContext::from
.
Implementations§
source§impl DeviceContext
impl DeviceContext
sourcepub fn new(
account_id: UserId,
segment_id: usize,
device_private_key: PrivateKey,
signing_private_key: DeviceSigningKeyPair
) -> DeviceContext
pub fn new( account_id: UserId, segment_id: usize, device_private_key: PrivateKey, signing_private_key: DeviceSigningKeyPair ) -> DeviceContext
Constructs a DeviceContext
from its components.
To instead generate a new DeviceContext
for the user, call generate_new_device
and pass the result to DeviceContext::from
.
sourcepub fn account_id(&self) -> &UserId
pub fn account_id(&self) -> &UserId
ID of the device’s owner
sourcepub fn segment_id(&self) -> usize
pub fn segment_id(&self) -> usize
ID of the segment
sourcepub fn signing_private_key(&self) -> &DeviceSigningKeyPair
pub fn signing_private_key(&self) -> &DeviceSigningKeyPair
Private signing key of the device
sourcepub fn device_private_key(&self) -> &PrivateKey
pub fn device_private_key(&self) -> &PrivateKey
Private encryption key of the device
Trait Implementations§
source§impl Clone for DeviceContext
impl Clone for DeviceContext
source§fn clone(&self) -> DeviceContext
fn clone(&self) -> DeviceContext
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for DeviceContext
impl Debug for DeviceContext
source§impl<'de> Deserialize<'de> for DeviceContext
impl<'de> Deserialize<'de> for DeviceContext
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl From<DeviceAddResult> for DeviceContext
impl From<DeviceAddResult> for DeviceContext
source§fn from(dar: DeviceAddResult) -> Self
fn from(dar: DeviceAddResult) -> Self
Converts to this type from the input type.
source§impl Hash for DeviceContext
impl Hash for DeviceContext
source§impl PartialEq for DeviceContext
impl PartialEq for DeviceContext
source§fn eq(&self, other: &DeviceContext) -> bool
fn eq(&self, other: &DeviceContext) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl Serialize for DeviceContext
impl Serialize for DeviceContext
impl Eq for DeviceContext
impl StructuralEq for DeviceContext
impl StructuralPartialEq for DeviceContext
Auto Trait Implementations§
impl RefUnwindSafe for DeviceContext
impl Send for DeviceContext
impl Sync for DeviceContext
impl Unpin for DeviceContext
impl UnwindSafe for DeviceContext
Blanket Implementations§
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
Mutably borrows from an owned value. Read more
source§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key
and return true
if they are equal.§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Checks if this value is equivalent to the given key. Read more