Struct DeviceData

pub struct DeviceData { /* private fields */ }

A read-only version of a Device.

Implementations

impl DeviceData

pub fn new(device_keys: DeviceKeys, trust_state: LocalTrust) -> Self

Create a new Device, this constructor skips signature verification of the keys, TryFrom should be used for completely new devices we receive.

pub fn user_id(&self) -> &UserId

The user id of the device owner.

pub fn device_id(&self) -> &DeviceId

The unique ID of the device.

pub fn display_name(&self) -> Option<&str>

Get the human readable name of the device.

pub fn get_key(&self, algorithm: DeviceKeyAlgorithm) -> Option<&DeviceKey>

Get the key of the given key algorithm belonging to this device.

pub fn curve25519_key(&self) -> Option<Curve25519PublicKey>

Get the Curve25519 key of the given device.

pub fn ed25519_key(&self) -> Option<Ed25519PublicKey>

Get the Ed25519 key of the given device.

pub fn keys(&self) -> &BTreeMap<OwnedDeviceKeyId, DeviceKey>

Get a map containing all the device keys.

pub fn signatures(&self) -> &Signatures

Get a map containing all the device signatures.

pub fn local_trust_state(&self) -> LocalTrust

Get the trust state of the device.

pub fn is_locally_trusted(&self) -> bool

Is the device locally marked as trusted.

pub fn is_blacklisted(&self) -> bool

Is the device locally marked as blacklisted.

Blacklisted devices won’t receive any group sessions.

pub fn was_withheld_code_sent(&self) -> bool

Returns true if the m.no_olm withheld code was already sent to this device.

pub fn algorithms(&self) -> &[EventEncryptionAlgorithm]

Get the list of algorithms this device supports.

pub fn supports_olm(&self) -> bool

Does this device support any of our known Olm encryption algorithms.

pub fn olm_session_config(&self) -> SessionConfig

Get the optimal SessionConfig for this device.

pub fn is_deleted(&self) -> bool

Is the device deleted.

pub fn as_device_keys(&self) -> &DeviceKeys

Return the device keys

pub fn from_account(account: &Account) -> DeviceData

Create DeviceData from an Account.

We will have our own device data in the store once we receive a /keys/query response, but this is useful to create it before we receive such a response.

It also makes it easier to check that the server doesn’t lie about our own device.

Don’t use this after we received a /keys/query response, other users/devices might add signatures to our own device, which can’t be replicated locally.

pub fn first_time_seen_ts(&self) -> MilliSecondsSinceUnixEpoch

Get the local timestamp of when this device was first persisted, in milliseconds since epoch (client local time).

Trait Implementations

impl Clone for DeviceData

fn clone(&self) -> DeviceData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceData

Available on non-tarpaulin_include only.

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DeviceData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DeviceData

fn eq(&self, other: &Self) -> 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 Serialize for DeviceData

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&DeviceKeys> for DeviceData

type Error = SignatureError

The type returned in the event of a conversion error.

fn try_from(device_keys: &DeviceKeys) -> Result<Self, Self::Error>

Performs the conversion.