Re-exports§
pub use self::db::SCHEMA_VERSION;pub use self::protocol::BLOCK_SIZE;pub use self::protocol::RepositoryId;pub use self::protocol::StorageSize;
Modules§
- crypto
- db
- path
- Utilities for working with filesystem paths.
- protocol
- Datatypes for the ouisync protocol and for interoperability between the network layer and the storage later
Structs§
- Branch
- Credentials
- Credentials for accessing a repository.
- Debug
Printer - Decode
Error - Device
Id - DeviceId uniquely identifies machines on which this software is running. Its only purpose is to ensure that one WriterId (which currently equates to sing::PublicKey) will never create two or more concurrent snapshots as that would break the whole repository. This is achieved by ensuring that there is always only a single DeviceId associated with a single WriterId.
- DhtLookup
Stream - Stream returned from [
Network::dht_lookup]. - DhtPin
- Ensures the DHT instances have been started and remain running until the pin is in scope. See [DhtDiscovery::pin] for more info.
- Directory
- Event
- Notification event
- File
- Info
Hash - 20-byte long identifier of nodes and objects on the DHT
- Joint
Directory - Unified view over multiple concurrent versions of a directory.
- Metadata
- Network
- Network
Builder - Network
Event Receiver - Network
Event Stream - Wrapper around
NetworkEventReceiverthat implementsStream. - Peer
Info - Information about a peer.
- Peer
Info Collector - Progress
- Progress of a task.
- Public
Runtime Id - Recv
Stream - Registration
- Repository
- Repository
Handle - Repository
Params - Secret
Runtime Id - Send
Stream - Share
Token - Token to share a repository. It can be encoded as a URL-formatted string and transmitted to other replicas.
- Stats
- Network traffic statistics.
- TopicId
- Identified of a network stream topic.
- UdpSocket
- Side channel for the underlying UDP socket which allows sending and receiving raw UDP datagrams.
- Version
Vector - Version vector.
- Write
Secrets - Secrets for write access.
Enums§
- Access
- Access
Change - How to change access to a repository.
- Access
Mode - Access mode of a repository.
- Access
Secrets - Secrets for access to a repository.
- Entry
Ref - Info about a directory entry.
- Entry
Type - Type of filesystem entry.
- Error
- Joint
Entry - Joint
Entry Ref - Local
Secret - Type of secret to unlock a repository.
- NatBehavior
- Network
Event - Network notification event.
- Payload
- Peer
Addr - Peer
Source - How was the peer discovered.
- Peer
State - SetLocal
Secret - Used to set or change the read or write local secret of a repository.
- Store
Error
Constants§
- BLOB_
HEADER_ SIZE - Size of the blob header in bytes.
- DATA_
VERSION - DEFAULT_
DHT_ ROUTERS - DIRECTORY_
VERSION - Version of the Directory serialization format.
- INFO_
HASH_ LEN - Length of
InfoHashin bytes.
Traits§
- Datagram
Socket - Trait for UDP-like sockets.
- DhtContacts
Store Trait - Persistent store for DHT contacts. It is periodically updated with the current DHT contacts and persisted. It is then used to provide additional nodes to bootstrap against on the next DHT discovery startup.
Functions§
- database_
files - List of repository database files. Includes the main db file and any auxiliary files.
- repository_
info_ hash
Type Aliases§
- Result
- A specialized
Resulttype for convenience.