pub struct RealmPlayground { /* private fields */ }Expand description
Represents details about a realm playground.
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 RealmPlayground
impl RealmPlayground
Sourcepub const fn id(&self) -> Option<u64>
pub const fn id(&self) -> Option<u64>
Gets the RealmPlayground id.
The unique ID for the realm playground.
Sourcepub fn set_id(&mut self, val: u64)
pub fn set_id(&mut self, val: u64)
Sets the RealmPlayground id.
The unique ID for the realm playground.
Sourcepub fn unset_id(&mut self) -> Option<u64>
pub fn unset_id(&mut self) -> Option<u64>
Unsets the RealmPlayground id.
The unique ID for the realm playground.
Sourcepub fn with_id(self, val: u64) -> Self
pub fn with_id(self, val: u64) -> Self
Builder function that sets the RealmPlayground id.
The unique ID for the realm playground.
Source§impl RealmPlayground
impl RealmPlayground
Sourcepub fn name(&self) -> Option<&str>
pub fn name(&self) -> Option<&str>
Gets the RealmPlayground name.
The user-visible display name of the playground.
Clients should display this in UI for picking which playground to open a code block in,
to differentiate between multiple configured playground options for a given pygments language.
Changes: New in Zulip 4.0 (feature level 49).
Sourcepub fn set_name<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)
pub fn set_name<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)
Sets the RealmPlayground name.
The user-visible display name of the playground.
Clients should display this in UI for picking which playground to open a code block in,
to differentiate between multiple configured playground options for a given pygments language.
Changes: New in Zulip 4.0 (feature level 49).
Sourcepub fn unset_name(&mut self) -> Option<String>
pub fn unset_name(&mut self) -> Option<String>
Unsets the RealmPlayground name.
The user-visible display name of the playground.
Clients should display this in UI for picking which playground to open a code block in,
to differentiate between multiple configured playground options for a given pygments language.
Changes: New in Zulip 4.0 (feature level 49).
Sourcepub fn with_name<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self
pub fn with_name<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self
Builder function that sets the RealmPlayground name.
The user-visible display name of the playground.
Clients should display this in UI for picking which playground to open a code block in,
to differentiate between multiple configured playground options for a given pygments language.
Changes: New in Zulip 4.0 (feature level 49).
Sourcepub fn pygments_language(&self) -> Option<&str>
pub fn pygments_language(&self) -> Option<&str>
Gets the RealmPlayground pygments_language.
The name of the Pygments language lexer for that programming language.
Sourcepub fn set_pygments_language<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)
pub fn set_pygments_language<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)
Sets the RealmPlayground pygments_language.
The name of the Pygments language lexer for that programming language.
Sourcepub fn unset_pygments_language(&mut self) -> Option<String>
pub fn unset_pygments_language(&mut self) -> Option<String>
Unsets the RealmPlayground pygments_language.
The name of the Pygments language lexer for that programming language.
Sourcepub fn with_pygments_language<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self
pub fn with_pygments_language<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self
Builder function that sets the RealmPlayground pygments_language.
The name of the Pygments language lexer for that programming language.
Sourcepub fn url_template(&self) -> Option<&str>
pub fn url_template(&self) -> Option<&str>
Gets the RealmPlayground url_template.
The RFC 6570 compliant URL template for the playground.
The template contains exactly one variable named code, which determines how the extracted code should be substituted in the playground URL.
Changes: New in Zulip 8.0 (feature level 196). This replaced the url_prefix parameter, which was used to construct URLs by just concatenating url_prefix and code.
Sourcepub fn set_url_template<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)
pub fn set_url_template<'a, C: Into<Cow<'a, str>>>(&mut self, val: C)
Sets the RealmPlayground url_template.
The RFC 6570 compliant URL template for the playground.
The template contains exactly one variable named code, which determines how the extracted code should be substituted in the playground URL.
Changes: New in Zulip 8.0 (feature level 196). This replaced the url_prefix parameter, which was used to construct URLs by just concatenating url_prefix and code.
Sourcepub fn unset_url_template(&mut self) -> Option<String>
pub fn unset_url_template(&mut self) -> Option<String>
Unsets the RealmPlayground url_template.
The RFC 6570 compliant URL template for the playground.
The template contains exactly one variable named code, which determines how the extracted code should be substituted in the playground URL.
Changes: New in Zulip 8.0 (feature level 196). This replaced the url_prefix parameter, which was used to construct URLs by just concatenating url_prefix and code.
Sourcepub fn with_url_template<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self
pub fn with_url_template<'a, C: Into<Cow<'a, str>>>(self, val: C) -> Self
Builder function that sets the RealmPlayground url_template.
The RFC 6570 compliant URL template for the playground.
The template contains exactly one variable named code, which determines how the extracted code should be substituted in the playground URL.
Changes: New in Zulip 8.0 (feature level 196). This replaced the url_prefix parameter, which was used to construct URLs by just concatenating url_prefix and code.