[][src]Crate safe_app

SAFE App.

Re-exports

pub use ffi::access_container::*;
pub use ffi::cipher_opt::*;
pub use ffi::crypto::*;
pub use ffi::immutable_data::*;
pub use ffi::ipc::*;
pub use ffi::logging::*;
pub use ffi::mdata_info::*;
pub use ffi::mutable_data::entries::*;
pub use ffi::mutable_data::entry_actions::*;
pub use ffi::mutable_data::metadata::*;
pub use ffi::mutable_data::permissions::*;
pub use ffi::mutable_data::*;
pub use ffi::nfs::*;
pub use ffi::object_cache::*;
pub use ffi::*;

Modules

cipher_opt

Cipher options.

ffi

FFI

immutable_data

Utilities for handling ImmutableData.

ipc

Inter-Process Communication utilities.

mdata_info

MDataInfo utilities.

nfs

NFS utilities.

object_cache

This module implements storage (cache) for objects that have to be passed across FFI boundaries.

permissions

Permissions utilities

utils

Utility functions.

Structs

App

Handle to an application instance.

AppClient

Client object used by safe_app.

ClientKeys

Client signing and encryption keypairs

ImmutableData

An immutable chunk of data.

MDataInfo

Information allowing to locate and access mutable data on the network.

MutableData

Mutable data.

PermissionSet

Set of user permissions.

Registered
Unregistered
Value

A value in MutableData

XorName

A XOR_NAME_BITS-bit number, viewed as a point in XOR space.

Enums

Action

Action a permission applies to

AppContext

Application context (data associated with the app).

AppError

App error.

ClientError

Errors in operations involving Core and Vaults

CoreError

Client Errors

EntryAction

Action performed on a single entry: insert, update or delete.

User

Subject of permissions

Constants

DIR_TAG

MutableData type tag for a directory.

ERR_ACCESS_DENIED
ERR_ACCOUNT_EXISTS
ERR_ALREADY_AUTHORISED
ERR_ASYMMETRIC_DECIPHER_FAILURE
ERR_AUTH_DENIED
ERR_CONFIG_FILE
ERR_CONTAINERS_DENIED
ERR_DATA_EXISTS
ERR_DATA_TOO_LARGE
ERR_ENCODE_DECODE_ERROR
ERR_FILE_EXISTS
ERR_FILE_NOT_FOUND
ERR_INCOMPATIBLE_MOCK_STATUS
ERR_INVALID_CIPHER_OPT_HANDLE
ERR_INVALID_ENCRYPT_PUB_KEY_HANDLE
ERR_INVALID_ENCRYPT_SEC_KEY_HANDLE
ERR_INVALID_ENTRY_ACTIONS
ERR_INVALID_FILE_CONTEXT_HANDLE
ERR_INVALID_FILE_MODE
ERR_INVALID_INVITATION
ERR_INVALID_MDATA_ENTRIES_HANDLE
ERR_INVALID_MDATA_ENTRY_ACTIONS_HANDLE
ERR_INVALID_MDATA_INFO_HANDLE
ERR_INVALID_MDATA_PERMISSIONS_HANDLE
ERR_INVALID_MDATA_PERMISSION_SET_HANDLE
ERR_INVALID_MSG
ERR_INVALID_OPERATION
ERR_INVALID_OWNER
ERR_INVALID_OWNERS
ERR_INVALID_RANGE
ERR_INVALID_SELF_ENCRYPTOR_HANDLE
ERR_INVALID_SELF_ENCRYPTOR_READ_OFFSETS
ERR_INVALID_SIGN_PUB_KEY_HANDLE
ERR_INVALID_SIGN_SEC_KEY_HANDLE
ERR_INVALID_SUCCESSOR
ERR_INVITATION_ALREADY_CLAIMED
ERR_IO
ERR_IO_ERROR
ERR_LOW_BALANCE
ERR_MPID_MESSAGING_ERROR
ERR_NETWORK_FULL
ERR_NETWORK_OTHER
ERR_NO_SUCH_ACCOUNT
ERR_NO_SUCH_CONTAINER
ERR_NO_SUCH_DATA
ERR_NO_SUCH_ENTRY
ERR_NO_SUCH_KEY
ERR_OPERATION_ABORTED
ERR_OPERATION_FORBIDDEN
ERR_RANDOM_DATA_GENERATION_FAILURE
ERR_RECEIVED_UNEXPECTED_DATA
ERR_RECEIVED_UNEXPECTED_EVENT
ERR_REQUEST_TIMEOUT
ERR_ROOT_DIRECTORY_EXISTS
ERR_ROUTING_ERROR
ERR_ROUTING_INTERFACE_ERROR
ERR_SELF_ENCRYPTION
ERR_SHARE_MDATA_DENIED
ERR_STRING_ERROR
ERR_SYMMETRIC_DECIPHER_FAILURE
ERR_TOO_MANY_ENTRIES
ERR_UNEXPECTED
ERR_UNKNOWN_APP
ERR_UNREGISTERED_CLIENT_ACCESS
ERR_UNSUCCESSFUL_PW_HASH
ERR_UNSUPPORTED_SALT_SIZE_FOR_PW_HASH
ERR_VERSION_CACHE_MISS
MAIDSAFE_TAG

All Maidsafe tagging should positive-offset from this.

XOR_NAME_LEN

Constant byte length of XorName.

Traits

Client

Trait providing an interface for self-authentication client implementations, so they can interface all requests from high level API's to the actual routing layer and manage all interactions with it. Essentially provides an interface for non-blocking Clients with an asynchronous API using the futures abstraction from the futures-rs crate.

FutureExt

Additional future combinators.

Functions

app_container_name

Gets name of the dedicated container of the given app.

Type Definitions

CoreFuture

Future trait returned from core operations.