libfw-core 0.2.0

Shared data structures, traits and protocol constants for libfw
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

//! Shared data structures, traits, protocol constants and streaming
//! compression abstractions for the libfw transfer library.
//!
//! `libfw-core` is the foundation crate consumed by both
//! [`libfw-server`](https://docs.rs/libfw-server) (server routing /
//! middleware) and [`libfw-client`](https://docs.rs/libfw-client) (WASM
//! engine + JS SDK). It contains no I/O of its own: it defines the *contracts*.
//!
//! # Highlights
//!
//! - [`TokenClaims`], [`Action`] and the [`Validator`] trait for
//!   fine-grained bearer-token authorization.
//! - [`StorageBackend`] and [`UploadSink`] traits for pluggable storage.
//! - [`Compressor`] / [`Decompressor`] streaming traits backed by
//!   [`zrip`] (zstd) with constant-memory guarantees.
//! - Protocol constants: [`CHUNK_SIZE`], [`HEADER_COMPRESS`],
//!   [`HEADER_FILE_META`] and friends.
//! - Transfer metadata ([`FileMeta`], [`TransferPlan`], [`ChunkMeta`]).
//!
//! # Example
//!
//! ```no_run
//! use libfw_core::auth::{Action, PathValidator, Validator};
//! use libfw_core::claims::{TokenClaims, Permission};
//!
//! let claims = TokenClaims {
//!     sub: "user-42".into(),
//!     exp: None,
//!     permissions: vec![Permission::Read, Permission::Write],
//!     allowed_paths: vec!["/docs/".into()],
//! };
//! let validator = PathValidator::new();
//! assert!(validator.validate(&claims, "/docs/spec.pdf", Action::Read).is_ok());
//! ```

pub mod auth;
pub mod claims;
pub mod compress;
pub mod constants;
pub mod error;
pub mod metadata;
pub mod range;
pub mod storage;
pub mod ws;

pub use auth::{Action, AuthError, PathValidator, TokenVerifier, Validator};
pub use claims::{Permission, TokenClaims};
pub use compress::{CompressionFormat, Compressor, Decompressor};
pub use constants::*;
pub use error::{CompressError, DecompressError, StorageError};
pub use metadata::{ChunkMeta, FileMeta, TransferPlan};
pub use range::RangeSpec;
pub use storage::{DirEntry, StorageBackend, UploadSink, WriteMode};
pub use ws::{
    Block, BlockSet, CompleteMessage, ErrorMessage, Hello, ReadyReply, StartRequest, TransferKind,
    block_bounds, block_count, block_frame, block_offset, control_frame, crc32, frame_payload,
    frame_type, missing_blocks, nak_frame, parse_block, parse_control, parse_nak, parse_req,
    req_frame, wave_done_frame, FRAME_BLOCK, FRAME_COMPLETE, FRAME_ERROR, FRAME_HELLO,
    FRAME_HELLO_OK, FRAME_LIST_REPLY, FRAME_LIST_REQ, FRAME_META_REPLY, FRAME_META_REQ, FRAME_NAK,
    FRAME_READY, FRAME_REQ, FRAME_START, FRAME_WAVE_DONE,
};