re_log_encoding 0.35.1-rc.1

Encode/decode and serialize/deserialize RRD streams
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

use std::sync::Arc;

use re_chunk::{Chunk, ChunkId};

use crate::{RawRrdManifest, RrdManifest};

#[cfg(feature = "decoder")]
mod rrd;

#[cfg(feature = "decoder")]
pub use self::rrd::RrdChunkProvider;

/// Backend that exposes an indexed chunk source.
///
/// A provider serves both the **index** (which chunks exist and their metadata) and the **bytes**
/// (the chunks themselves).
///
/// ## Contract
///
/// - All `ids` in [`Self::load_chunks`] must be known to the provider (i.e. root chunks
///   present in [`Self::manifest`]). Unknown ids produce an error and abort the batch.
/// - The returned `Vec<Arc<Chunk>>` may be in any order; callers must not rely on input ordering.
/// - [`Self::manifest`] and [`Self::raw_manifest`] are stable for the lifetime of the provider —
///   they never change once constructed.
#[async_trait::async_trait]
pub trait ChunkProvider: Send + Sync {
    /// The validated, indexed manifest of chunks this provider serves.
    fn manifest(&self) -> &Arc<RrdManifest>;

    /// The raw, as-parsed manifest. Kept around so consumers (e.g. the server's `GetRrdManifest`
    /// handler) can re-serialize without re-validating.
    fn raw_manifest(&self) -> &Arc<RawRrdManifest>;

    /// Human-readable identifier for this provider's backing source, used in diagnostic messages
    /// (e.g. an RRD path or a segment id). Not parsed; format is purely for display.
    fn source(&self) -> String;

    /// Load chunks by id.
    async fn load_chunks(&self, ids: &[ChunkId]) -> Result<Vec<Arc<Chunk>>, ChunkProviderError>;
}

/// Provider-level error.
#[derive(thiserror::Error, Debug)]
#[error(transparent)]
pub struct ChunkProviderError(pub Box<dyn std::error::Error + Send + Sync + 'static>);