Skip to main content

Draft

Struct Draft 

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

Represents a message draft.

Modified from openapi-generator-cli output:

$ openapi-generator-cli generate -g rust -i ./zerver/openapi/zulip.yaml -o zulip-openapi --skip-validate-spec
/*
* Zulip REST API
*
* Powerful open source group chat
*
* The version of the OpenAPI document: 1.0.0
*
* Generated by: https://openapi-generator.tech
*/

See zerver/openapi/zulip.yaml for the original OpenAPI configuration.

Configuration slightly modified to work with the Rust generator of openapi-generator-cli.

Implementations§

Source§

impl Draft

Source

pub const fn new() -> Self

Creates a new Draft.

Source§

impl Draft

Source

pub const fn id(&self) -> Option<i64>

Gets the Draft id.

The unique ID of the draft.

It will only used whenever the drafts are fetched.

This field should not be specified when the draft is being created or edited.

Source

pub fn set_id(&mut self, val: i64)

Sets the Draft id.

The unique ID of the draft.

It will only used whenever the drafts are fetched.

This field should not be specified when the draft is being created or edited.

Source

pub fn unset_id(&mut self) -> Option<i64>

Unsets the Draft id.

The unique ID of the draft.

It will only used whenever the drafts are fetched.

This field should not be specified when the draft is being created or edited.

Source

pub fn with_id(self, val: i64) -> Self

Builder function that sets the Draft id.

The unique ID of the draft.

It will only used whenever the drafts are fetched.

This field should not be specified when the draft is being created or edited.

Source

pub const fn timestamp(&self) -> Option<u64>

Gets the Draft timestamp.

A Unix timestamp (seconds only) representing when the draft was last edited.

When creating a draft, this key need not be present and it will be filled in automatically by the server.

Source

pub fn set_timestamp(&mut self, val: u64)

Sets the Draft timestamp.

A Unix timestamp (seconds only) representing when the draft was last edited.

When creating a draft, this key need not be present and it will be filled in automatically by the server.

Source

pub fn unset_timestamp(&mut self) -> Option<u64>

Unsets the Draft timestamp.

A Unix timestamp (seconds only) representing when the draft was last edited.

When creating a draft, this key need not be present and it will be filled in automatically by the server.

Source

pub fn with_timestamp(self, val: u64) -> Self

Builder function that sets the Draft timestamp.

A Unix timestamp (seconds only) representing when the draft was last edited.

When creating a draft, this key need not be present and it will be filled in automatically by the server.

Source§

impl Draft

Source

pub const fn draft_type(&self) -> DraftType

Gets the Draft draft_type.

The type of the draft.

Either unaddressed (empty string), \"stream\", or \"private\" (for one-on-one and group direct messages).

Source

pub fn set_draft_type(&mut self, val: DraftType)

Sets the Draft draft_type.

The type of the draft.

Either unaddressed (empty string), \"stream\", or \"private\" (for one-on-one and group direct messages).

Source

pub fn with_draft_type(self, val: DraftType) -> Self

Builder function that sets the Draft draft_type.

The type of the draft.

Either unaddressed (empty string), \"stream\", or \"private\" (for one-on-one and group direct messages).

Source§

impl Draft

Source

pub fn to(&self) -> &[u64]

Gets the Draft to.

An array of the tentative target audience IDs.

For channel messages, this should contain exactly 1 ID, the ID of the target channel.

For direct messages, this should be an array of target user IDs.

For unaddressed drafts, this is ignored, and clients should send an empty array.

Source

pub fn set_to<'a, C: Into<Cow<'a, [u64]>>>(&mut self, val: C)

Sets the Draft to.

An array of the tentative target audience IDs.

For channel messages, this should contain exactly 1 ID, the ID of the target channel.

For direct messages, this should be an array of target user IDs.

For unaddressed drafts, this is ignored, and clients should send an empty array.

Source

pub fn with_to<'a, C: Into<Cow<'a, [u64]>>>(self, val: C) -> Self

Builder function that sets the Draft to.

An array of the tentative target audience IDs.

For channel messages, this should contain exactly 1 ID, the ID of the target channel.

For direct messages, this should be an array of target user IDs.

For unaddressed drafts, this is ignored, and clients should send an empty array.

Source

pub fn topic(&self) -> &str

Gets the Draft topic.

For channel message drafts, the tentative topic name.

For direct or unaddressed messages, this will be ignored and should ideally be the empty string.

Should not contain null bytes.

Source

pub fn set_topic<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)

Sets the Draft topic.

For channel message drafts, the tentative topic name.

For direct or unaddressed messages, this will be ignored and should ideally be the empty string.

Should not contain null bytes.

Source

pub fn with_topic<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self

Builder function that sets the Draft topic.

For channel message drafts, the tentative topic name.

For direct or unaddressed messages, this will be ignored and should ideally be the empty string.

Should not contain null bytes.

Source

pub fn content(&self) -> &str

Gets the Draft content.

The body of the draft.

Should not contain null bytes.

Source

pub fn set_content<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)

Sets the Draft content.

The body of the draft.

Should not contain null bytes.

Source

pub fn with_content<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self

Builder function that sets the Draft content.

The body of the draft.

Should not contain null bytes.

Trait Implementations§

Source§

impl Clone for Draft

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 Draft

Source§

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

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

impl Default for Draft

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Draft

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 Display for Draft

Source§

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

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

impl PartialEq for Draft

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Draft

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
Source§

impl StructuralPartialEq for Draft

Auto Trait Implementations§

§

impl Freeze for Draft

§

impl RefUnwindSafe for Draft

§

impl Send for Draft

§

impl Sync for Draft

§

impl Unpin for Draft

§

impl UnsafeUnpin for Draft

§

impl UnwindSafe for Draft

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.
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