Skip to main content

NodeConfig

Struct NodeConfig 

Source
pub struct NodeConfig {
    pub node_id: NodeId,
    pub storage_uri: String,
    pub cache_dir: PathBuf,
    pub cores: usize,
    pub memory_bytes: u64,
    pub memory_per_bee: u64,
    pub target_cell_size: u64,
    pub max_cell_size: u64,
    pub min_cell_size: u64,
    pub max_cache_size: u64,
    pub heartbeat_interval: Duration,
    pub dead_threshold: Duration,
}
Expand description

Configuration for an Apiary node, including auto-detected system capacity.

Fields§

§node_id: NodeId

Unique identifier for this node.

§storage_uri: String

Storage URI: "local://~/.apiary/data" or "s3://bucket/prefix".

§cache_dir: PathBuf

Local directory for cell cache and scratch files.

§cores: usize

Number of CPU cores (auto-detected).

§memory_bytes: u64

Total memory in bytes (auto-detected).

§memory_per_bee: u64

Memory budget per bee in bytes (memory_bytes / cores).

§target_cell_size: u64

Target cell size in bytes for leafcutter sizing (memory_per_bee / 4).

§max_cell_size: u64

Maximum cell size in bytes (target_cell_size * 2).

§min_cell_size: u64

Minimum cell size in bytes (floor to amortise S3 overhead).

§max_cache_size: u64

Maximum cache size in bytes for local cell storage.

§heartbeat_interval: Duration

Interval between heartbeat writes.

§dead_threshold: Duration

Duration after which a node with no heartbeat is considered dead.

Implementations§

Source§

impl NodeConfig

Source

pub fn detect(storage_uri: impl Into<String>) -> Self

Create a new NodeConfig by auto-detecting system resources.

§Arguments
  • storage_uri — The storage backend URI (e.g., "local://~/.apiary/data" or "s3://bucket/prefix").
§Example
use apiary_core::config::NodeConfig;

let config = NodeConfig::detect("local://~/.apiary/data");
assert!(config.cores > 0);
assert!(config.memory_bytes > 0);

Trait Implementations§

Source§

impl Clone for NodeConfig

Source§

fn clone(&self) -> NodeConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for NodeConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for NodeConfig

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for NodeConfig

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,