Annotation

hypothesis_rs::annotations

Struct Annotation

pub struct Annotation {Show 16 fields
    pub id: String,
    pub created: OffsetDateTime,
    pub updated: OffsetDateTime,
    pub user: UserAccountID,
    pub uri: String,
    pub text: String,
    pub tags: Vec<String>,
    pub group: String,
    pub permissions: Permissions,
    pub target: Vec<Target>,
    pub links: HashMap<String, String>,
    pub hidden: bool,
    pub flagged: bool,
    pub document: Option<Document>,
    pub references: Vec<String>,
    pub user_info: Option<UserInfo>,
}

Expand description

Full representation of an Annotation resource and applicable relationships.

Fields§

§id: String

Annotation ID

§created: OffsetDateTime

Date of creation

§updated: OffsetDateTime

Date of last update

§user: UserAccountID

User account ID in the format “acct:@”

§uri: String

URL of document this annotation is attached to

§text: String

The text content of the annotation body (NOT the selected text in the document)

§tags: Vec<String>

Tags attached to annotation

§group: String

The unique identifier for the annotation’s group

§permissions: Permissions§target: Vec<Target>

Which part of the document does the annotation target.

§links: HashMap<String, String>

An object containing hypermedia links for this annotation

§hidden: bool

Whether this annotation is hidden from public view

§flagged: bool

Whether this annotation has one or more flags for moderation

§document: Option<Document>

Document information

§references: Vec<String>

Annotation IDs for any annotations this annotation references (e.g. is a reply to)

§user_info: Option<UserInfo>

Implementations§

impl Annotation

pub fn update(&mut self, annotation: InputAnnotation)

Trait Implementations§

impl Clone for Annotation

fn clone(&self) -> Annotation

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

impl Debug for Annotation

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Annotation

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for Annotation

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

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

1.0.0 · Source§

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 Serialize for Annotation

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for Annotation

Auto Trait Implementations§

impl Freeze for Annotation

impl RefUnwindSafe for Annotation

impl Send for Annotation

impl Sync for Annotation

impl Unpin for Annotation

impl UnwindSafe for Annotation

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> ErasedDestructor for T
where T: 'static,