Enum ckb_resource::Resource

pub enum Resource {
    Bundled {
        bundled: String,
    },
    FileSystem {
        file: PathBuf,
    },
}

Represents a resource, which is either bundled in the CKB binary or resident in the local file system.

Variants

Bundled

A resource that bundled in the CKB binary.

Fields of Bundled

bundled: String

The identifier of the bundled resource.

FileSystem

A resource that resides in the local file system.

Fields of FileSystem

file: PathBuf

The file path to the resource.

Implementations

impl Resource

pub fn bundled(bundled: String) -> Resource

Creates a reference to the bundled resource.

pub fn file_system(file: PathBuf) -> Resource

Creates a reference to the resource recident in the file system.

pub fn ckb_config<P: AsRef<Path>>(root_dir: P) -> Resource

Creates the CKB config file resource from the file system.

It searches the file name CKB_CONFIG_FILE_NAME in the directory root_dir.

pub fn miner_config<P: AsRef<Path>>(root_dir: P) -> Resource

Creates the CKB miner config file resource from the file system.

It searches the file name MINER_CONFIG_FILE_NAME in the directory root_dir.

pub fn db_options<P: AsRef<Path>>(root_dir: P) -> Resource

Creates the RocksDB options file resource from the file system.

It searches the file name DB_OPTIONS_FILE_NAME in the directory root_dir.

pub fn bundled_ckb_config() -> Resource

Creates the bundled CKB config file resource.

pub fn bundled_miner_config() -> Resource

Creates the bundled CKB miner config file resource.

pub fn bundled_db_options() -> Resource

Creates the bundled RocksDB options file resource.

pub fn exported_in<P: AsRef<Path>>(root_dir: P) -> bool

Checks whether any of the bundled resource has been exported in the specified directory.

This can be used to avoid overwritting to export all the bundled resources to the specified directory.

pub fn is_bundled(&self) -> bool

Returns true if this is a bundled resource.

pub fn exists(&self) -> bool

Returns true if the resource exists.

The bundled resource exists only when the identifier is included in the bundle.

The file system resource exists only when the file exists.

pub fn parent(&self) -> Option<&Path>

The parent directory of the resource.

It always returns None on bundled resource.

pub fn absolutize<P: AsRef<Path>>(&mut self, base: P)

Modifies the file system resource to ensure the path is absolute.

If the path is relative, expand the path relative to the directory base.

pub fn get(&self) -> Result<Cow<'static, [u8]>>

Gets resource content.

pub fn read(&self) -> Result<Box<dyn Read>>

Gets resource content via an input stream.

pub fn export<'a, P: AsRef<Path>>(
    &self,
    context: &TemplateContext<'a>,
    root_dir: P
) -> Result<()>

Exports a bundled resource.

This function returns Ok immediatly when invoked on a file system resource.

The file is exported to the path by combining root_dir and the resource indentifier.

These bundled files can be customized for different chains using spec branches. See Template.

Trait Implementations

impl Clone for Resource

fn clone(&self) -> Resource

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Resource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Resource

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Resource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<Resource> for Resource

fn eq(&self, other: &Resource) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Resource) -> bool

This method tests for !=.

impl Serialize for Resource

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for Resource

impl StructuralEq for Resource

impl StructuralPartialEq for Resource