Struct RawDoc

pub struct RawDoc {
    pub payload: BTreeMap<PayloadId, Payload>,
    pub delegates: Vec<Did>,
    pub threshold: usize,
    pub visibility: Visibility,
    /* private fields */
}

RawDoc is similar to the Doc type, however, it can be edited and may not be valid.

It is expected that any changes to a Doc are made via RawDoc, and then verified by using RawDoc::verified.

Note that RawDoc only implements Deserialize. This prevents us from serializing an unverified document, while also making sure that any document that is deserialized is verified.

Fields

payload: BTreeMap<PayloadId, Payload>

The payload section.

delegates: Vec<Did>

The delegates section.

threshold: usize

The signature threshold.

visibility: Visibility

Repository visibility.

Implementations

impl RawDoc

pub fn new( project: Project, delegates: Vec<Did>, threshold: usize, visibility: Visibility, ) -> RawDoc

Construct a new RawDoc with an initial RawDoc::payload containing the provided Project, and the given delegates, threshold, and visibility.

pub fn version(&self) -> &Version

Get the version of the document.

pub fn project(&self) -> Result<Project, PayloadError>

Get the project payload, if it exists and is valid, out of this document.

pub fn is_delegate(&self, did: &Did) -> bool

Check if the given did is in the set of RawDoc::delegates.

pub fn delegate(&mut self, did: Did)

Add a new delegate to the document.

Note that if this Did is a duplicate, then the resulting set will only show it once.

pub fn rescind(&mut self, did: &Did) -> Result<bool, DocError>

Remove the did from the set of delegates. Returns true if it was removed.

pub fn from_json(bytes: &[u8]) -> Result<RawDoc, DocError>

Construct the RawDoc from the set of bytes that are expected to be in JSON format.

pub fn verified(self) -> Result<Doc, DocError>

Verify the RawDoc’s values, converting it into a valid Doc.

The verifications are as follows:

• RawDoc::delegates: any duplicates are removed, and for the remaining set ensure that it is non-empty and does not exceed a length of MAX_DELEGATES.
• RawDoc::threshold: ensure that it is in the range [1, delegates.len()].

Trait Implementations

impl Clone for RawDoc

fn clone(&self) -> RawDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RawDoc

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RawDoc

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GetCanonicalRefs for RawDoc

type Error = CanonicalRefsError

fn canonical_refs( &self, ) -> Result<Option<CanonicalRefs>, <RawDoc as GetCanonicalRefs>::Error>

Retrieve the CanonicalRefs, returning Some if they are not present, and None if they are missing.

fn raw_canonical_refs( &self, ) -> Result<Option<RawCanonicalRefs>, <RawDoc as GetCanonicalRefs>::Error>

Retrieve the RawCanonicalRefs, returning Some if they are not present, and None if they are missing.

fn canonical_refs_or_default<D, E>( &self, default: D, ) -> Result<CanonicalRefs, E>

where D: Fn() -> Result<CanonicalRefs, E>, E: From<Self::Error>,

Retrieve the CanonicalRefs, and in the case of None, then use the default function to return a default set of CanonicalRefs.

impl PartialEq for RawDoc

fn eq(&self, other: &RawDoc) -> 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 TryFrom<RawDoc> for Doc

type Error = DocError

The type returned in the event of a conversion error.

fn try_from(doc: RawDoc) -> Result<Doc, <Doc as TryFrom<RawDoc>>::Error>

Performs the conversion.

impl Eq for RawDoc

impl StructuralPartialEq for RawDoc