[][src]Module ironoxide::prelude

Convenience re-export of essential IronOxide types

Re-exports

pub use crate::document::DocumentOps;
pub use crate::group::GroupOps;
pub use crate::policy::PolicyGrant;
pub use crate::user::UserOps;
pub use crate::IronOxide;

Structs

DeviceContext

Account's device context. Needed to initialize the Sdk with a set of device keys. See IronOxide.initialize()

DeviceId

Device ID type. Validates that the provided ID is greater than 0

DeviceName

Device name type. Validates that the provided name isn't an empty string

DocumentId

Document ID. Unique within the segment. Must match the regex ^[a-zA-Z0-9_.$#|@/:;=+'-]+$

DocumentName

(unencrypted) name of a document. Construct via try_from(&str)

GroupId

Group ID. Unique within a segment. Must match the regex ^[a-zA-Z0-9_.$#|@/:;=+'-]+$

GroupName

Group's user-assigned name. (non-unique)

UserId

ID of a user. Unique with in a segment. Must match the regex ^[a-zA-Z0-9_.$#|@/:;=+'-]+$

Enums

IronOxideErr

Errors generated by IronOxide SDK operations