Struct fuel_indexer_lib::manifest::Manifest

pub struct Manifest { /* private fields */ }

Represents the indexer manifest file.

This manifest file is a simple YAML file that is read and passed to the excecutor to which the indexer is registered. This manifest specifies various properties of how the indexer should be run in the indexer executor (e.g., Where should the indexing start?).

Implementations

impl Manifest

pub fn from_file(path: impl AsRef<Path>) -> Result<Self, ManifestError>

Derive an indexer manifest via the YAML file at the specified path.

pub fn graphql_schema_content(&self) -> Result<GraphQLSchema, ManifestError>

Return the raw GraphQL schema string for an indexer manifest.

pub fn uid(&self) -> String

Derive the unique identifier for a manifest.

pub fn execution_source(&self) -> ExecutionSource

Determine what type of execution source this indexer is using.

pub fn module_bytes(&self) -> Result<Vec<u8>, ManifestError>

Return the bytes of the compiled indexer WASM module.

Note that as mentioned, because native execution does not compile to a module that can be uploaded (as WASM execution does), there is no way to read module bytes if native execution is specified.

pub fn write(&self, path: &PathBuf) -> Result<(), ManifestError>

Write this manifest to a given path.

pub fn set_start_block(&mut self, block: u32)

Set the start block for this indexer.

pub fn set_module(&mut self, module: Module)

Set the executor module for this indexer.

pub fn set_graphql_schema(&mut self, schema: String)

Set the GraphQL schema for this indexer.

pub fn set_abi(&mut self, abi: String)

Set the contract ABI for this indexer.

pub fn namespace(&self) -> &str

pub fn identifier(&self) -> &str

pub fn graphql_schema(&self) -> &str

pub fn start_block(&self) -> Option<u32>

pub fn contract_id(&self) -> &ContractIds

pub fn abi(&self) -> Option<&str>

pub fn fuel_client(&self) -> Option<&str>

pub fn module(&self) -> &Module

pub fn end_block(&self) -> Option<u32>

pub fn resumable(&self) -> Option<bool>

Trait Implementations

impl Clone for Manifest

fn clone(&self) -> Manifest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Manifest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Manifest

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

Deserialize this value from the given Serde deserializer.

impl From<Manifest> for Vec<u8>

fn from(manifest: Manifest) -> Self

Converts to this type from the input type.

impl Serialize for Manifest

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

Serialize this value into the given Serde serializer.

impl TryFrom<&Vec<u8, Global>> for Manifest

type Error = ManifestError

The type returned in the event of a conversion error.

fn try_from(val: &Vec<u8>) -> Result<Self, ManifestError>

Performs the conversion.

impl TryFrom<&str> for Manifest

type Error = ManifestError

The type returned in the event of a conversion error.

fn try_from(val: &str) -> Result<Self, ManifestError>

Performs the conversion.