Skip to main content

Builder

Struct Builder 

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

Builds an object and emits its canonical bytes.

Implementations§

Source§

impl Builder

Source

pub fn created(self, when: &str) -> Self

Set the creation instant (RFC 3339 UTC, second precision).

§Example
use publet_core::Object;

let bytes = Object::builder("claim.prose", AUTHOR)
    .created("2026-10-05T00:00:00Z")
    .build()?;
assert_eq!(Object::parse(&bytes)?.peek().created(), "2026-10-05T00:00:00Z");
Source

pub fn field(self, key: &str, value: Value) -> Self

Insert a body field.

§Example
use publet_core::{Object, cbor::Value};

// Fields may be added in any order; the encoding sorts them.
let one = Object::builder("note", AUTHOR)
    .created("2026-10-05T00:00:00Z")
    .field("b", Value::Uint(2))
    .field("a", Value::Uint(1))
    .build()?;
let other = Object::builder("note", AUTHOR)
    .created("2026-10-05T00:00:00Z")
    .field("a", Value::Uint(1))
    .field("b", Value::Uint(2))
    .build()?;
assert_eq!(one, other);
Source

pub fn prev(self, cid: &str) -> Self

Name the author’s previous object.

§Example
use publet_core::{Cid, HashAlg, Object};

let first = Object::builder("note", AUTHOR).created("2026-10-05T00:00:00Z").build()?;
let first_cid = Cid::of(&first, HashAlg::Sha2_256);

let second = Object::builder("note", AUTHOR)
    .created("2026-10-06T00:00:00Z")
    .prev(&first_cid.to_string())
    .build()?;
assert_eq!(Object::parse(&second)?.peek().prev(), Some(&first_cid));
Source

pub fn basis(self, cid: &str) -> Self

Name the state the author was looking at (Section 4.6).

§Example
use publet_core::{Cid, HashAlg, Object};

// The state the author had read when writing this.
let read = Cid::of(b"the head the author was looking at", HashAlg::Sha2_256);
let bytes = Object::builder("note", AUTHOR)
    .created("2026-10-05T00:00:00Z")
    .basis(&read.to_string())
    .build()?;
assert_eq!(Object::parse(&bytes)?.peek().basis(), Some(&read));
Source

pub fn build(self) -> Result<Vec<u8>, ObjectError>

Emit canonical bytes.

§Errors

Returns ObjectError if a CID-valued field does not parse or if no creation instant was set.

§Example
use publet_core::{Object, ObjectError};

let bytes = Object::builder("note", AUTHOR).created("2026-10-05T00:00:00Z").build()?;
assert!(Object::parse(&bytes).is_ok());

// A creation instant is required.
assert_eq!(
    Object::builder("note", AUTHOR).build(),
    Err(ObjectError::MissingField { field: "created" }),
);

// The author must be an identifier.
assert!(matches!(
    Object::builder("note", "not an identifier").created("2026-10-05T00:00:00Z").build(),
    Err(ObjectError::BadCid { field: "author", .. }),
));

Trait Implementations§

Source§

impl Clone for Builder

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Builder

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

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

fn try_from(value: U) -> Result<T, !>

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.