Trait tbf::FileSystem

pub trait FileSystem {
    type Error;
    fn add_file<I>(&self, data: &[u8], tags: I) -> Result<FileId, Self::Error>
    where
        I: IntoIterator<Item = Tag>;
    fn edit_file<I>(
        &self, 
        id: FileId, 
        data: Option<&[u8]>, 
        tags: Option<I>
    ) -> Result<(), Self::Error>
    where
        I: IntoIterator<Item = Tag>;
    fn remove_file(&self, id: FileId) -> Result<(), Self::Error>;
    fn search_tags<P>(&self, tags: P) -> Result<Vec<FileId>, Self::Error>
    where
        P: TagPattern;
    fn get_info(&self, id: FileId) -> Result<FileInfo, Self::Error>;
}

A trait representing an implementation of a tag-based filesystem.

Associated Types

type Error

The error type to use with this filesystem.

Required methods

fn add_file<I>(&self, data: &[u8], tags: I) -> Result<FileId, Self::Error> where
    I: IntoIterator<Item = Tag>, 

Add a new file with the given data and tags

fn edit_file<I>(
    &self,
    id: FileId,
    data: Option<&[u8]>,
    tags: Option<I>
) -> Result<(), Self::Error> where
    I: IntoIterator<Item = Tag>, 

Edit an existing file, altering the data or tags

fn remove_file(&self, id: FileId) -> Result<(), Self::Error>

Remove an existing file

fn search_tags<P>(&self, tags: P) -> Result<Vec<FileId>, Self::Error> where
    P: TagPattern, 

Search for files matching a given tag pattern

fn get_info(&self, id: FileId) -> Result<FileInfo, Self::Error>

Get info about an existing file

Implementors

impl FileSystem for DirectoryBackedFs

impl FileSystem for InMemoryFs