Atom

Struct Atom 

Source
pub struct Atom { /* private fields */ }
Expand description

An immutable data container that represents a single version of content in the database.

Atoms are the fundamental building blocks of the database’s immutable data storage system. Each Atom contains:

  • A unique identifier
  • The source schema that defines its structure
  • The public key of the creator
  • Creation timestamp
  • Optional reference to a previous version
  • The actual content data

Atoms form a chain of versions through their prev_atom_uuid references, enabling complete version history tracking. Once created, an Atom’s content cannot be modified, ensuring data immutability.

Implementations§

Source§

impl Atom

Source

pub fn new( source_schema_name: String, source_pub_key: String, content: Value, ) -> Self

Creates a new Atom with the given parameters.

§Arguments
  • source_schema_name - Name of the schema that defines this Atom’s structure
  • source_pub_key - Public key of the entity creating this Atom
  • content - The actual data content stored in this Atom
§Returns

A new Atom instance with a content-based UUID and current timestamp

Source

pub fn with_prev_version(self, prev_atom_uuid: String) -> Self

Creates a new Atom that references a previous version

Source

pub fn with_source_file_name(self, file_name: String) -> Self

Sets the source file name for atoms created from file uploads

Source

pub fn with_status(self, status: AtomStatus) -> Self

Source

pub const fn content(&self) -> &Value

Returns a reference to the Atom’s content.

This method provides read-only access to the stored data, maintaining the immutability principle.

Source

pub fn set_status(&mut self, status: AtomStatus)

Source

pub fn get_transformed_content(&self, transform: &str) -> Value

Applies a transformation to the Atom’s content and returns the result.

Currently supports:

  • “lowercase”: Converts string content to lowercase

If the transformation is not recognized or cannot be applied, returns a clone of the original content.

§Arguments
  • transform - The name of the transformation to apply
Source

pub fn uuid(&self) -> &str

Returns the unique identifier of this Atom.

This UUID uniquely identifies this specific version of the data and is used by Molecules to point to the current version.

Source

pub fn source_schema_name(&self) -> &str

Returns the name of the schema that defines this Atom’s structure.

The schema name is used to validate the content structure and determine applicable permissions and payment requirements.

Source

pub fn source_pub_key(&self) -> &str

Returns the public key of the entity that created this Atom.

This is used for authentication and permission validation when accessing or modifying the data.

Source

pub fn source_file_name(&self) -> Option<&String>

Returns the original filename if this atom was created from a file upload.

This is used for tracking data provenance and auditing purposes.

Source

pub const fn created_at(&self) -> DateTime<Utc>

Returns the timestamp when this Atom was created.

This timestamp is used for auditing and version history tracking.

Source

pub const fn prev_atom_uuid(&self) -> Option<&String>

Returns the UUID of the previous version of this data, if any.

This forms the chain of version history, allowing traversal through all previous versions of the data.

Trait Implementations§

Source§

impl Clone for Atom

Source§

fn clone(&self) -> Atom

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 Atom

Source§

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

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

impl<'de> Deserialize<'de> for Atom

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 Atom

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§

§

impl Freeze for Atom

§

impl RefUnwindSafe for Atom

§

impl Send for Atom

§

impl Sync for Atom

§

impl Unpin for Atom

§

impl UnwindSafe for Atom

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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>,