Struct StoreId 

pub struct StoreId { /* private fields */ }

A unique id per store.

The kind of store is part of the id, and can be either a StoreKind::Recording or a StoreKind::Blueprint.

Uniqueness

All data associated with a given StoreId, regardless of its source, is considered to belong to the same logical recording. As such, when ingested in the viewer, they will be pooled into a single store and displayed as a single, in-viewer recording. This can be very confusing if it happens inadvertently. However, the ability to pool data sharing the same StoreId can be very powerful. As a result, we do not want to enforce uniqueness. Still, it is important to understand what a StoreId is, and, to avoid footguns, default to make them unique.

In the context of the logging SDK, the application id is a mandatory, user-defined string. By default, the recording id is a UUID, which ensures unique-by-default behavior. The user can override the recording id though. In that case, the user is responsible for making the application id/recording id pair unique or not, based on their needs.

In the context of remote recordings (aka a dataset’s partition), the application id is the dataset entry id, and the recording id is the partition id. The former is a UUID, and the latter is, by definition, unique within the dataset entry. As a result, the uniqueness of the StoreId is always guaranteed in this case.

Implementations

impl StoreId

pub fn new( kind: StoreKind, application_id: impl Into<ApplicationId>, recording_id: impl Into<RecordingId>, ) -> StoreId

pub fn recording( application_id: impl Into<ApplicationId>, recording_id: impl Into<RecordingId>, ) -> StoreId

pub fn default_blueprint(application_id: ApplicationId) -> StoreId

Create a Self for the default blueprint of a given application id

pub fn random( kind: StoreKind, application_id: impl Into<ApplicationId>, ) -> StoreId

Generate a random StoreId with the provided application id.

Note: the application id is required here because fully random store ids are often a logically incorrect thing to build (the notable exceptions being tests).

pub fn empty_recording() -> StoreId

pub fn with_recording_id(self, recording_id: impl Into<RecordingId>) -> StoreId

pub fn with_application_id( self, application_id: impl Into<ApplicationId>, ) -> StoreId

pub fn from_uuid( kind: StoreKind, application_id: ApplicationId, uuid: Uuid, ) -> StoreId

pub fn is_empty_recording(&self) -> bool

pub fn is_default_blueprint(&self) -> bool

pub fn kind(&self) -> StoreKind

pub fn is_recording(&self) -> bool

pub fn is_blueprint(&self) -> bool

pub fn recording_id(&self) -> &RecordingId

pub fn application_id(&self) -> &ApplicationId

Trait Implementations

impl Clone for StoreId

fn clone(&self) -> StoreId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StoreId

More compact debug representation of a StoreId.

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StoreId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for StoreId

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for StoreId

fn cmp(&self, other: &StoreId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for StoreId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for StoreId

fn partial_cmp(&self, other: &StoreId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for StoreId

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SizeBytes for StoreId

fn heap_size_bytes(&self) -> u64

Returns how many bytes self uses on the heap.

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

impl TryFrom<StoreId> for StoreId

Convert a store id

type Error = StoreIdMissingApplicationIdError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for StoreId

impl StructuralPartialEq for StoreId