Struct twilight_http::request::channel::update_channel::UpdateChannel[−][src]

pub struct UpdateChannel<'a> { /* fields omitted */ }

Expand description

Update a channel.

All fields are optional. The minimum length of the name is 2 UTF-16 characters and the maximum is 100 UTF-16 characters.

Implementations

impl<'a> UpdateChannel<'a>[src]

pub fn bitrate(self, bitrate: u64) -> Self[src]

Set the bitrate of the channel. Applicable to voice channels only.

pub fn name(self, name: impl Into<String>) -> Result<Self, UpdateChannelError>[src]

Set the name.

The minimum length is 2 UTF-16 characters and the maximum is 100 UTF-16 characters.

Errors

Returns an UpdateChannelErrorType::NameInvalid error type if the name length is too short or too long.

pub fn nsfw(self, nsfw: bool) -> Self[src]

Set whether the channel is marked as NSFW.

pub fn parent_id(self, parent_id: impl Into<Option<ChannelId>>) -> Self[src]

If this is specified, and the parent ID is a ChannelType::CategoryChannel, move this channel to a child of the category channel.

pub fn permission_overwrites(
    self, 
    permission_overwrites: Vec<PermissionOverwrite>
) -> Self

[src]

Set the permission overwrites of a channel. This will overwrite all permissions that the channel currently has, so use with caution!

pub fn position(self, position: u64) -> Self[src]

Set the position of the channel.

Positions are numerical and zero-indexed. If you place a channel at position 2, channels 2-n will shift down one position and the initial channel will take its place.

pub fn rate_limit_per_user(
    self, 
    rate_limit_per_user: u64
) -> Result<Self, UpdateChannelError>

[src]

Set the number of seconds that a user must wait before before they are able to send another message.

The minimum is 0 and the maximum is 21600. Refer to the discord docs for more details. This is also known as “Slow Mode”.

Errors

Returns an UpdateChannelErrorType::RateLimitPerUserInvalid error type if the amount is greater than 21600.

pub fn topic(self, topic: impl Into<String>) -> Result<Self, UpdateChannelError>[src]

Set the topic.

The maximum length is 1024 UTF-16 characters. Refer to the discord docs for more details.

Errors

Returns an UpdateChannelErrorType::TopicInvalid error type if the topic length is too long.

pub fn user_limit(self, user_limit: u64) -> Self[src]

For voice channels, set the user limit.

Set to 0 for no limit. Limit can otherwise be between 1 and 99 inclusive. Refer to the discord docs for more details.

pub fn video_quality_mode(self, video_quality_mode: VideoQualityMode) -> Self[src]

Set the VideoQualityMode for the voice channel.

pub fn kind(self, kind: ChannelType) -> Self[src]

Set the kind of channel.

Only conversion between ChannelType::GuildText and ChannelType::GuildNews is possible, and only if the guild has the NEWS feature enabled. Refer to the discord docs for more details.

Trait Implementations

impl<'a> AuditLogReason for UpdateChannel<'a>[src]

fn reason(self, reason: impl Into<String>) -> Result<Self, AuditLogReasonError>[src]

impl Future for UpdateChannel<'_>[src]

type Output = Result<Channel, Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>[src]

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

Auto Trait Implementations

impl<'a> !RefUnwindSafe for UpdateChannel<'a>

impl<'a> Send for UpdateChannel<'a>

impl<'a> !Sync for UpdateChannel<'a>

impl<'a> Unpin for UpdateChannel<'a>

impl<'a> !UnwindSafe for UpdateChannel<'a>

Blanket Implementations

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

[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

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

[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

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

[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> FutureExt for T where
    T: Future + ?Sized,

fn map<U, F>(self, f: F) -> Map<Self, F> where
    F: FnOnce(Self::Output) -> U,

Map this future’s output to a different type, returning a new future of the resulting type. Read more

fn map_into<U>(self) -> MapInto<Self, U> where
    Self::Output: Into<U>,

Map this future’s output to a different type, returning a new future of the resulting type. Read more

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
    F: FnOnce(Self::Output) -> Fut,
    Fut: Future,

Chain on a computation for when a future finished, passing the result of the future to the provided closure f. Read more

fn left_future<B>(self) -> Either<Self, B> where
    B: Future<Output = Self::Output>,

Wrap this future in an Either future, making it the left-hand variant of that Either. Read more

fn right_future<A>(self) -> Either<A, Self> where
    A: Future<Output = Self::Output>,

Wrap this future in an Either future, making it the right-hand variant of that Either. Read more

fn into_stream(self) -> IntoStream<Self>

Convert this future into a single element stream. Read more

fn flatten(self) -> Flatten<Self> where
    Self::Output: Future,

Flatten the execution of this future when the output of this future is itself another future. Read more

fn flatten_stream(self) -> FlattenStream<Self> where
    Self::Output: Stream,

Flatten the execution of this future when the successful result of this future is a stream. Read more

fn fuse(self) -> Fuse<Self>

Fuse a future such that poll will never again be called once it has completed. This method can be used to turn any Future into a FusedFuture. Read more

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnOnce(&Self::Output),

Do something with the output of a future before passing it on. Read more

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe,

Catches unwinding panics while polling the future. Read more

fn shared(self) -> Shared<Self> where
    Self::Output: Clone,

Create a cloneable handle to this future where all handles will resolve to the same result. Read more

fn boxed<'a>(
    self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>> where
    Self: Send + 'a,

Wrap the future in a Box, pinning it. Read more

fn boxed_local<'a>(
    self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
    Self: 'a,

Wrap the future in a Box, pinning it. Read more

fn unit_error(self) -> UnitError<Self>

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = ()>. Read more

fn never_error(self) -> NeverError<Self>

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = Never>. Read more

fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
    Self: Unpin,

A convenience for calling Future::poll on Unpin future types.

fn now_or_never(self) -> Option<Self::Output>

Evaluates and consumes the future, returning the resulting output if the future is ready after the first call to Future::poll. Read more

impl<T> Instrument for T[src]

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

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

fn in_current_span(self) -> Instrumented<Self>[src]

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

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

[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<F> IntoFuture for F where
    F: Future,

[src]

type Output = <F as Future>::Output

🔬 This is a nightly-only experimental API. (into_future)

The output that the future will produce on completion.

type Future = F

🔬 This is a nightly-only experimental API. (into_future)

Which kind of future are we turning this into?

pub fn into_future(self) -> <F as IntoFuture>::Future[src]

🔬 This is a nightly-only experimental API. (into_future)

Creates a future from a value.

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

[src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<F, T, E> TryFuture for F where
    F: Future<Output = Result<T, E>> + ?Sized,

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

pub fn try_poll(
    self: Pin<&mut F>, 
    cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>

Poll this TryFuture as if it were a Future. Read more

impl<Fut> TryFutureExt for Fut where
    Fut: TryFuture + ?Sized,

fn map_ok<T, F>(self, f: F) -> MapOk<Self, F> where
    F: FnOnce(Self::Ok) -> T,

Maps this future’s success value to a different value. Read more

fn map_ok_or_else<T, E, F>(self, e: E, f: F) -> MapOkOrElse<Self, F, E> where
    E: FnOnce(Self::Error) -> T,
    F: FnOnce(Self::Ok) -> T,

Maps this future’s success value to a different value, and permits for error handling resulting in the same type. Read more

fn map_err<E, F>(self, f: F) -> MapErr<Self, F> where
    F: FnOnce(Self::Error) -> E,

Maps this future’s error value to a different value. Read more

fn err_into<E>(self) -> ErrInto<Self, E> where
    Self::Error: Into<E>,

Maps this future’s Error to a new error type using the Into trait. Read more

fn ok_into<U>(self) -> OkInto<Self, U> where
    Self::Ok: Into<U>,

Maps this future’s Ok to a new type using the Into trait. Read more

fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F> where
    F: FnOnce(Self::Ok) -> Fut,
    Fut: TryFuture<Error = Self::Error>,

Executes another future after this one resolves successfully. The success value is passed to a closure to create this subsequent future. Read more

fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F> where
    F: FnOnce(Self::Error) -> Fut,
    Fut: TryFuture<Ok = Self::Ok>,

Executes another future if this one resolves to an error. The error value is passed to a closure to create this subsequent future. Read more

fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F> where
    F: FnOnce(&Self::Ok),

Do something with the success value of a future before passing it on. Read more

fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
    F: FnOnce(&Self::Error),

Do something with the error value of a future before passing it on. Read more

fn try_flatten(self) -> TryFlatten<Self, Self::Ok> where
    Self::Ok: TryFuture,
    <Self::Ok as TryFuture>::Error == Self::Error,

Flatten the execution of this future when the successful result of this future is another future. Read more

fn try_flatten_stream(self) -> TryFlattenStream<Self> where
    Self::Ok: TryStream,
    <Self::Ok as TryStream>::Error == Self::Error,

Flatten the execution of this future when the successful result of this future is a stream. Read more

fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F> where
    F: FnOnce(Self::Error) -> Self::Ok,

Unwraps this future’s output, producing a future with this future’s Ok type as its Output type. Read more

fn into_future(self) -> IntoFuture<Self>

Wraps a [TryFuture] into a type that implements Future. Read more

fn try_poll_unpin(
    &mut self, 
    cx: &mut Context<'_>
) -> Poll<Result<Self::Ok, Self::Error>> where
    Self: Unpin,

A convenience method for calling [TryFuture::try_poll] on Unpin future types. Read more

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

[src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,

pub fn vzip(self) -> V