[][src]Crate safe_core

SAFE Core.

Configuring SAFE Core

Please see the Configuring Client Libs section of the wiki.

Re-exports

pub use ffi::arrays::*;
pub use ffi::ipc::req::*;
pub use ffi::ipc::resp::*;
pub use ffi::nfs::*;
pub use ffi::*;
pub use self::client::mdata_info;
pub use self::client::recovery;
pub use self::client::test_create_balance;
pub use self::client::AuthActions;
pub use self::client::Client;
pub use self::client::ClientKeys;
pub use self::client::MDataInfo;
pub use self::config_handler::config_dir;
pub use self::event_loop::CoreFuture;
pub use self::event_loop::CoreMsg;
pub use self::event_loop::CoreMsgRx;
pub use self::event_loop::CoreMsgTx;
pub use self::self_encryption_storage::SelfEncryptionStorage;
pub use self::self_encryption_storage::SelfEncryptionStorageError;
pub use self::utils::logging;

Modules

client

Client trait and related constants.

config_handler

Config file handling.

crypto

Cryptographic utilities. Secret encryption and signing keys with more secure cloning semantics. These keys implement implicit sharing of the underlying sensitive data to avoid multiple copies of it stored in the memory, preventing certain class of attacks.

event_loop

Event loop handling.

ffi

FFI.

immutable_data

Utilities for handling ImmutableData.

ipc

Inter-Process Communication utilities.

nfs

NFS utilities.

self_encryption_storage

Implements the Self Encryption storage trait.

utils

Utility functions.

Macros

btree_map

Easily create a BTreeMap with the key => value syntax.

btree_set

Easily create a BTreeSet.

err

This is the equivalent of Result::Ok() adapted to deal with futures. This should be used to construct the return type equivalent of Result::Err in futures paradigm.

fry

This is the equivalent try! adapted to deal with futures. It is to be read as future-try. This will convert errors from Result into a done future with corresponding error and return.

ok

This is the equivalent of Result::Ok() adapted to deal with futures. This should be used to construct the return type equivalent of Result::Ok in futures paradigm.

Structs

ConnectionManager

Initialises QuicP2p instance. Establishes new connections. Contains a reference to crossbeam channel provided by quic-p2p for capturing the events.

QuicP2pConfig

QuicP2p configurations

Enums

CoreError

Client Errors

NetworkEvent

Network Events that Client Modules need to deal with.

Constants

DIR_TAG

MutableData type tag for a directory.

MAIDSAFE_TAG

All Maidsafe tagging should positive-offset from this.

Traits

FutureExt

Additional future combinators.

Functions

app_container_name

Gets name of the dedicated container of the given app.

Type Definitions

NetworkRx

NetworkEvent receiver stream.

NetworkTx

NetworkEvent transmitter.