Skip to main content

SystemCapabilities

Struct SystemCapabilities 

Source
pub struct SystemCapabilities {
    pub platform: Platform,
    pub kernel_version: Option<KernelVersion>,
    pub cpu_count: usize,
    pub physical_cores: usize,
    pub numa_nodes: usize,
    pub cache_line_size: usize,
    pub cpu_features: CpuFeatures,
    pub io_uring: IoUringCapabilities,
    pub xdp: XdpCapabilities,
    pub storage: StorageInfo,
    pub memory: MemoryInfo,
}
Expand description

Detected system capabilities.

This struct aggregates all detected hardware and software capabilities into a single view, making it easy to configure LaminarDB optimally.

Detection is performed lazily and cached for efficiency.

Fields§

§platform: Platform

Detected platform.

§kernel_version: Option<KernelVersion>

Detected kernel version (Linux/macOS only).

§cpu_count: usize

Number of logical CPUs.

§physical_cores: usize

Number of physical CPU cores.

§numa_nodes: usize

Number of NUMA nodes.

§cache_line_size: usize

Cache line size in bytes.

§cpu_features: CpuFeatures

CPU feature flags.

§io_uring: IoUringCapabilities

io_uring capabilities.

§xdp: XdpCapabilities

XDP capabilities.

§storage: StorageInfo

Storage information (for data directory).

§memory: MemoryInfo

Memory information.

Implementations§

Source§

impl SystemCapabilities

Source

pub fn detect() -> &'static Self

Detect all system capabilities.

This method is safe to call multiple times - results are cached after the first detection.

Source

pub fn detect_uncached() -> Self

Detect capabilities without caching.

Use detect() for normal usage.

Source

pub fn detect_with_storage<P: AsRef<Path>>(data_path: P) -> Self

Detect capabilities with storage detection for a specific path.

Source

pub fn update_storage<P: AsRef<Path>>(&mut self, data_path: P)

Update storage detection for a new path.

Source

pub fn recommended_config(&self) -> RecommendedConfig

Get recommended configuration based on detected capabilities.

Source

pub fn summary(&self) -> String

Generate a human-readable summary of all capabilities.

Source

pub fn is_fully_optimized(&self) -> bool

Check if all advanced features are available.

Source

pub fn meets_minimum_requirements(&self) -> bool

Check if the system meets minimum requirements for LaminarDB.

Source

pub fn missing_features(&self) -> Vec<&'static str>

Get a list of missing features that would improve performance.

Source

pub fn log_summary(&self)

Log the detected capabilities.

Trait Implementations§

Source§

impl Clone for SystemCapabilities

Source§

fn clone(&self) -> SystemCapabilities

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 SystemCapabilities

Source§

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

Formats the value using the given formatter. 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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
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> Allocation for T
where T: RefUnwindSafe + Send + Sync,