Trait Storage

pub trait Storage:
    Send
    + Sync
    + 'static {
    type Segment: Segment;
    type Config: Clone + Send;

    // Required methods
    fn store(
        &self,
        namespace: &NamespaceName,
        seg: Self::Segment,
        config_override: Option<Self::Config>,
        on_store: OnStoreCallback,
    );
    fn durable_frame_no(
        &self,
        namespace: &NamespaceName,
        config_override: Option<Self::Config>,
    ) -> impl Future<Output = Result<u64>> + Send;
    async fn restore(
        &self,
        file: impl FileExt,
        namespace: &NamespaceName,
        restore_options: RestoreOptions,
        config_override: Option<Self::Config>,
    ) -> Result<()>;
    fn find_segment(
        &self,
        namespace: &NamespaceName,
        frame_no: FindSegmentReq,
        config_override: Option<Self::Config>,
    ) -> impl Future<Output = Result<SegmentKey>> + Send;
    fn fetch_segment_index(
        &self,
        namespace: &NamespaceName,
        key: &SegmentKey,
        config_override: Option<Self::Config>,
    ) -> impl Future<Output = Result<Map<Arc<[u8]>>>> + Send;
    fn fetch_segment_data(
        &self,
        namespace: &NamespaceName,
        key: &SegmentKey,
        config_override: Option<Self::Config>,
    ) -> impl Future<Output = Result<CompactedSegment<impl FileExt>>> + Send;
    fn list_segments<'a>(
        &'a self,
        namespace: &'a NamespaceName,
        until: u64,
        config_override: Option<Self::Config>,
    ) -> impl Stream<Item = Result<SegmentInfo>> + 'a;

    // Provided method
    fn shutdown(&self) -> impl Future<Output = ()> + Send { ... }
}

Required Associated Types

type Segment: Segment

type Config: Clone + Send

Required Methods

fn store( &self, namespace: &NamespaceName, seg: Self::Segment, config_override: Option<Self::Config>, on_store: OnStoreCallback, )

store the passed segment for namespace. This function is called in a context where blocking is acceptable. returns a future that resolves when the segment is stored The segment should be stored whether or not the future is polled.

fn durable_frame_no( &self, namespace: &NamespaceName, config_override: Option<Self::Config>, ) -> impl Future<Output = Result<u64>> + Send

async fn restore( &self, file: impl FileExt, namespace: &NamespaceName, restore_options: RestoreOptions, config_override: Option<Self::Config>, ) -> Result<()>

fn find_segment( &self, namespace: &NamespaceName, frame_no: FindSegmentReq, config_override: Option<Self::Config>, ) -> impl Future<Output = Result<SegmentKey>> + Send

fn fetch_segment_index( &self, namespace: &NamespaceName, key: &SegmentKey, config_override: Option<Self::Config>, ) -> impl Future<Output = Result<Map<Arc<[u8]>>>> + Send

fn fetch_segment_data( &self, namespace: &NamespaceName, key: &SegmentKey, config_override: Option<Self::Config>, ) -> impl Future<Output = Result<CompactedSegment<impl FileExt>>> + Send

fn list_segments<'a>( &'a self, namespace: &'a NamespaceName, until: u64, config_override: Option<Self::Config>, ) -> impl Stream<Item = Result<SegmentInfo>> + 'a

Provided Methods

fn shutdown(&self) -> impl Future<Output = ()> + Send

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<A, B, S> Storage for Either<A, B>

where A: Storage<Segment = S>, B: Storage<Segment = S>, S: Segment,

type Segment = S

type Config = Either<<A as Storage>::Config, <B as Storage>::Config>

fn store( &self, namespace: &NamespaceName, seg: Self::Segment, config_override: Option<Self::Config>, on_store: OnStoreCallback, )

async fn durable_frame_no( &self, namespace: &NamespaceName, config_override: Option<Self::Config>, ) -> Result<u64>

async fn restore( &self, file: impl FileExt, namespace: &NamespaceName, restore_options: RestoreOptions, config_override: Option<Self::Config>, ) -> Result<()>

fn find_segment( &self, namespace: &NamespaceName, frame_no: FindSegmentReq, config_override: Option<Self::Config>, ) -> impl Future<Output = Result<SegmentKey>> + Send

fn fetch_segment_index( &self, namespace: &NamespaceName, key: &SegmentKey, config_override: Option<Self::Config>, ) -> impl Future<Output = Result<Map<Arc<[u8]>>>> + Send

fn fetch_segment_data( &self, namespace: &NamespaceName, key: &SegmentKey, config_override: Option<Self::Config>, ) -> impl Future<Output = Result<CompactedSegment<impl FileExt>>> + Send

async fn shutdown(&self)

fn list_segments<'a>( &'a self, namespace: &'a NamespaceName, until: u64, config_override: Option<Self::Config>, ) -> impl Stream<Item = Result<SegmentInfo>> + 'a

Implementors

impl Storage for NoStorage

type Config = ()

type Segment = SealedSegment<File>

impl<B, S> Storage for AsyncStorage<B, S>

where B: Backend, S: Segment,

type Segment = S

type Config = <B as Backend>::Config