Skip to main content

RealmEmoji

Struct RealmEmoji 

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

Represents details about the emoji with the specified ID. It has the following properties:

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 RealmEmoji

Source

pub const fn new() -> Self

Creates a new RealmEmoji.

Source§

impl RealmEmoji

Source

pub fn id(&self) -> Option<&str>

Gets the RealmEmoji id.

The ID for this emoji, same as the object’s key.

Source

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

Sets the RealmEmoji id.

The ID for this emoji, same as the object’s key.

Source

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

Unsets the RealmEmoji id.

The ID for this emoji, same as the object’s key.

Source

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

Builder function that sets the RealmEmoji id.

The ID for this emoji, same as the object’s key.

Source

pub fn name(&self) -> Option<&str>

Gets the RealmEmoji name.

The user-friendly name for this emoji.

Users in the organization can use this emoji by writing this name between colons (:name :).

Source

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

Sets the RealmEmoji name.

The user-friendly name for this emoji.

Users in the organization can use this emoji by writing this name between colons (:name :).

Source

pub fn unset_name(&mut self) -> Option<String>

Unsets the RealmEmoji name.

The user-friendly name for this emoji.

Users in the organization can use this emoji by writing this name between colons (:name :).

Source

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

Builder function that sets the RealmEmoji name.

The user-friendly name for this emoji.

Users in the organization can use this emoji by writing this name between colons (:name :).

Source

pub fn source_url(&self) -> Option<&str>

Gets the RealmEmoji source_url.

The path relative to the organization’s URL where the emoji’s image can be found.

Source

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

Sets the RealmEmoji source_url.

The path relative to the organization’s URL where the emoji’s image can be found.

Source

pub fn unset_source_url(&mut self) -> Option<String>

Unsets the RealmEmoji source_url.

The path relative to the organization’s URL where the emoji’s image can be found.

Source

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

Builder function that sets the RealmEmoji source_url.

The path relative to the organization’s URL where the emoji’s image can be found.

Source

pub fn still_url(&self) -> Option<&str>

Gets the RealmEmoji still_url.

Only non-null when the emoji’s image is animated.

The path relative to the organization’s URL where a still (not animated) version of the emoji can be found.

(This is currently always the first frame of the animation).

This is useful for clients to display the emoji in contexts where continuously animating it would be a bad user experience (e.g. because it would be distracting).

Changes: New in Zulip 5.0 (added as optional field in feature level 97 and then made mandatory, but nullable, in feature level 113).

Source

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

Sets the RealmEmoji still_url.

Only non-null when the emoji’s image is animated.

The path relative to the organization’s URL where a still (not animated) version of the emoji can be found.

(This is currently always the first frame of the animation).

This is useful for clients to display the emoji in contexts where continuously animating it would be a bad user experience (e.g. because it would be distracting).

Changes: New in Zulip 5.0 (added as optional field in feature level 97 and then made mandatory, but nullable, in feature level 113).

Source

pub fn unset_still_url(&mut self) -> Option<String>

Unsets the RealmEmoji still_url.

Only non-null when the emoji’s image is animated.

The path relative to the organization’s URL where a still (not animated) version of the emoji can be found.

(This is currently always the first frame of the animation).

This is useful for clients to display the emoji in contexts where continuously animating it would be a bad user experience (e.g. because it would be distracting).

Changes: New in Zulip 5.0 (added as optional field in feature level 97 and then made mandatory, but nullable, in feature level 113).

Source

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

Builder function that sets the RealmEmoji still_url.

Only non-null when the emoji’s image is animated.

The path relative to the organization’s URL where a still (not animated) version of the emoji can be found.

(This is currently always the first frame of the animation).

This is useful for clients to display the emoji in contexts where continuously animating it would be a bad user experience (e.g. because it would be distracting).

Changes: New in Zulip 5.0 (added as optional field in feature level 97 and then made mandatory, but nullable, in feature level 113).

Source§

impl RealmEmoji

Source

pub const fn deactivated(&self) -> Option<bool>

Gets the RealmEmoji deactivated.

Whether the emoji has been deactivated or not.

Source

pub fn set_deactivated(&mut self, val: bool)

Sets the RealmEmoji deactivated.

Whether the emoji has been deactivated or not.

Source

pub fn unset_deactivated(&mut self) -> Option<bool>

Unsets the RealmEmoji deactivated.

Whether the emoji has been deactivated or not.

Source

pub fn with_deactivated(self, val: bool) -> Self

Builder function that sets the RealmEmoji deactivated.

Whether the emoji has been deactivated or not.

Source

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

Gets the RealmEmoji author_id.

The user ID of the user who uploaded the custom emoji.

Will be null if the uploader is unknown.

Changes: New in Zulip 3.0 (feature level 7). Previously was accessible via an author object with an id field.

Source

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

Sets the RealmEmoji author_id.

The user ID of the user who uploaded the custom emoji.

Will be null if the uploader is unknown.

Changes: New in Zulip 3.0 (feature level 7). Previously was accessible via an author object with an id field.

Source

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

Unsets the RealmEmoji author_id.

The user ID of the user who uploaded the custom emoji.

Will be null if the uploader is unknown.

Changes: New in Zulip 3.0 (feature level 7). Previously was accessible via an author object with an id field.

Source

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

Builder function that sets the RealmEmoji author_id.

The user ID of the user who uploaded the custom emoji.

Will be null if the uploader is unknown.

Changes: New in Zulip 3.0 (feature level 7). Previously was accessible via an author object with an id field.

Trait Implementations§

Source§

impl Clone for RealmEmoji

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 RealmEmoji

Source§

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

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

impl Default for RealmEmoji

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for RealmEmoji

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 RealmEmoji

Source§

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

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

impl PartialEq for RealmEmoji

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 RealmEmoji

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 RealmEmoji

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