Trait keeshond_datapack::source::Source [−][src]
pub trait Source { fn get_uri(&self) -> &str; fn has_package(&self, package_name: &str) -> bool; fn list_packages(&mut self) -> Vec<String>; fn read_file(
&mut self,
full_pathname: &str
) -> Result<Box<dyn ReadSeek>, PackageError>; fn iter_entries(
&mut self,
package_name: &str,
type_folder: &str
) -> Box<dyn Iterator<Item = Result<String, PackageError>>>; fn trust_level(&self, package_name: &str) -> TrustLevel; fn write_file(
&mut self,
full_pathname: &str
) -> Result<Box<dyn Write>, PackageError> { ... } }
Expand description
Represents a location that packages can be loaded from. For example, you could load packages from the filesystem (via FilesystemSource, or out of a special archive format.
Required methods
fn get_uri(&self) -> &str
[src]
fn get_uri(&self) -> &str
[src]The path that this Source originates from. Only used for debug purposes.
fn has_package(&self, package_name: &str) -> bool
[src]
fn has_package(&self, package_name: &str) -> bool
[src]Returns true if the Source has a package of the given name, otherwise returns false
fn list_packages(&mut self) -> Vec<String>
[src]
fn list_packages(&mut self) -> Vec<String>
[src]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>
[src]
fn read_file(
&mut self,
full_pathname: &str
) -> Result<Box<dyn ReadSeek>, PackageError>
[src]Returns a [Read] + [Seek] for the file at the given pathname, if one exists.
fn iter_entries(
&mut self,
package_name: &str,
type_folder: &str
) -> Box<dyn Iterator<Item = Result<String, PackageError>>>
[src]
fn iter_entries(
&mut self,
package_name: &str,
type_folder: &str
) -> Box<dyn Iterator<Item = Result<String, PackageError>>>
[src]Returns an iterator through the items in a given package, if the Source has said package
fn trust_level(&self, package_name: &str) -> TrustLevel
[src]
fn trust_level(&self, package_name: &str) -> TrustLevel
[src]Returns the source’s trust level for the given package. Trusted sources are able to load resource types marked as requiring trust.
Provided methods
fn write_file(
&mut self,
full_pathname: &str
) -> Result<Box<dyn Write>, PackageError>
[src]
fn write_file(
&mut self,
full_pathname: &str
) -> Result<Box<dyn Write>, PackageError>
[src]Returns a Write for the file at the given pathname.
Implementors
impl Source for FilesystemSource
[src]
impl Source for FilesystemSource
[src]fn get_uri(&self) -> &str
[src]
fn has_package(&self, package_name: &str) -> bool
[src]
fn list_packages(&mut self) -> Vec<String>
[src]
fn read_file(
&mut self,
full_pathname: &str
) -> Result<Box<dyn ReadSeek>, PackageError>
[src]
&mut self,
full_pathname: &str
) -> Result<Box<dyn ReadSeek>, PackageError>
fn write_file(
&mut self,
full_pathname: &str
) -> Result<Box<dyn Write>, PackageError>
[src]
&mut self,
full_pathname: &str
) -> Result<Box<dyn Write>, PackageError>
fn iter_entries(
&mut self,
package_name: &str,
type_folder: &str
) -> Box<dyn Iterator<Item = Result<String, PackageError>>>
[src]
&mut self,
package_name: &str,
type_folder: &str
) -> Box<dyn Iterator<Item = Result<String, PackageError>>>