Struct SystemInfo 

pub struct SystemInfo<T = u64> {
    pub heap_size: T,
    pub used_size: T,
    pub cpu_time: u32,
    pub cpu_time_epoch: u32,
    pub timestamp: Option<T>,
    pub client_heap: Option<T>,
    pub client_used: Option<T>,
}

Metadata about the engine runtime (such as total heap utilization).

Fields

heap_size: T

Total available bytes for allocation on the [Server].

used_size: T

Bytes allocated for use on the [Server].

cpu_time: u32

Wall-clock time spent processing requests on the [Server], in milliseconds (estimated). This does not properly account for the internal thread pool (which enables column-parallel processing of individual requests).

cpu_time_epoch: u32

Milliseconds since internal CPU time accumulator was reset.

timestamp: Option<T>

Timestamp (POSIX) this request was made. This field may be omitted for wasm due to perspective-client lacking a dependency on wasm_bindgen.

client_heap: Option<T>

Total available bytes for allocation on the Client. This is only available if trace-allocator is enabled.

client_used: Option<T>

Bytes allocated for use on the Client. This is only available if trace-allocator is enabled.

Implementations

impl<U: Copy + 'static> SystemInfo<U>

pub fn cast<T: Copy + 'static>(&self) -> SystemInfo<T>

where U: AsPrimitive<T>,

Convert the numeric representation for T to something else, which is useful for JavaScript where there is no u64 native type.

Trait Implementations

impl<T: Clone> Clone for SystemInfo<T>

fn clone(&self) -> SystemInfo<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SystemInfo<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for SystemInfo<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Serialize for SystemInfo<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> TS for SystemInfo<T>

where T: TS,

type WithoutGenerics = SystemInfo<Dummy>

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = SystemInfo<T>

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.