Struct keeshond_datapack::source::FilesystemSource

pub struct FilesystemSource { /* fields omitted */ }

A Source that loads packages from the filesystem. This is a good source to use for development, or if you don’t care about packaging your data files into an archive.

Implementations

impl FilesystemSource

pub fn new(directory: &str, trust: TrustLevel) -> FilesystemSource

Creates a new FilesystemSource using the given directory to look for packages in

Trait Implementations

impl Source for FilesystemSource

fn get_uri(&self) -> &str

The path that this Source originates from. Only used for debug purposes.

fn has_package(&self, package_name: &str) -> bool

Returns true if the Source has a package of the given name, otherwise returns false

fn list_packages(&mut self) -> Vec<String>

Returns a list of all packages available in this Source. Do not call this repeatedly!

fn read_file(
    &mut self,
    full_pathname: &str
) -> Result<Box<dyn ReadSeek>, PackageError>

Returns a [Read] + [Seek] for the file at the given pathname, if one exists.

fn write_file(
    &mut self,
    full_pathname: &str
) -> Result<Box<dyn Write>, PackageError>

Returns a Write for the file at the given pathname.

fn iter_entries(
    &mut self,
    package_name: &str,
    type_folder: &str
) -> Box<dyn Iterator<Item = Result<String, PackageError>>>

Returns an iterator through the items in a given package, if the Source has said package

fn trust_level(&self, _package_name: &str) -> TrustLevel

Returns the source’s trust level for the given package. Trusted sources are able to load resource types marked as requiring trust.