Fix typo: underlaying => underlying
parent
bdd51a323a
commit
3c9f929598
|
@ -34,7 +34,7 @@ impl Common {
|
||||||
/// # Arguments
|
/// # Arguments
|
||||||
/// * `client` - The client used to make requests.
|
/// * `client` - The client used to make requests.
|
||||||
///
|
///
|
||||||
/// * `room` - The underlaying room.
|
/// * `room` - The underlying room.
|
||||||
pub fn new(client: Client, room: BaseRoom) -> Self {
|
pub fn new(client: Client, room: BaseRoom) -> Self {
|
||||||
// TODO: Make this private
|
// TODO: Make this private
|
||||||
Self { inner: room, client }
|
Self { inner: room, client }
|
||||||
|
|
|
@ -5,7 +5,7 @@ use crate::{room::Common, BaseRoom, Client, Result, RoomType};
|
||||||
/// A room in the invited state.
|
/// A room in the invited state.
|
||||||
///
|
///
|
||||||
/// This struct contains all methodes specific to a `Room` with type
|
/// This struct contains all methodes specific to a `Room` with type
|
||||||
/// `RoomType::Invited`. Operations may fail once the underlaying `Room` changes
|
/// `RoomType::Invited`. Operations may fail once the underlying `Room` changes
|
||||||
/// `RoomType`.
|
/// `RoomType`.
|
||||||
#[derive(Debug, Clone)]
|
#[derive(Debug, Clone)]
|
||||||
pub struct Invited {
|
pub struct Invited {
|
||||||
|
@ -13,13 +13,13 @@ pub struct Invited {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Invited {
|
impl Invited {
|
||||||
/// Create a new `room::Invited` if the underlaying `Room` has type
|
/// Create a new `room::Invited` if the underlying `Room` has type
|
||||||
/// `RoomType::Invited`.
|
/// `RoomType::Invited`.
|
||||||
///
|
///
|
||||||
/// # Arguments
|
/// # Arguments
|
||||||
/// * `client` - The client used to make requests.
|
/// * `client` - The client used to make requests.
|
||||||
///
|
///
|
||||||
/// * `room` - The underlaying room.
|
/// * `room` - The underlying room.
|
||||||
pub fn new(client: Client, room: BaseRoom) -> Option<Self> {
|
pub fn new(client: Client, room: BaseRoom) -> Option<Self> {
|
||||||
// TODO: Make this private
|
// TODO: Make this private
|
||||||
if room.room_type() == RoomType::Invited {
|
if room.room_type() == RoomType::Invited {
|
||||||
|
|
|
@ -48,7 +48,7 @@ const TYPING_NOTICE_RESEND_TIMEOUT: Duration = Duration::from_secs(3);
|
||||||
/// A room in the joined state.
|
/// A room in the joined state.
|
||||||
///
|
///
|
||||||
/// The `JoinedRoom` contains all methodes specific to a `Room` with type
|
/// The `JoinedRoom` contains all methodes specific to a `Room` with type
|
||||||
/// `RoomType::Joined`. Operations may fail once the underlaying `Room` changes
|
/// `RoomType::Joined`. Operations may fail once the underlying `Room` changes
|
||||||
/// `RoomType`.
|
/// `RoomType`.
|
||||||
#[derive(Debug, Clone)]
|
#[derive(Debug, Clone)]
|
||||||
pub struct Joined {
|
pub struct Joined {
|
||||||
|
@ -64,13 +64,13 @@ impl Deref for Joined {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Joined {
|
impl Joined {
|
||||||
/// Create a new `room::Joined` if the underlaying `BaseRoom` has type
|
/// Create a new `room::Joined` if the underlying `BaseRoom` has type
|
||||||
/// `RoomType::Joined`.
|
/// `RoomType::Joined`.
|
||||||
///
|
///
|
||||||
/// # Arguments
|
/// # Arguments
|
||||||
/// * `client` - The client used to make requests.
|
/// * `client` - The client used to make requests.
|
||||||
///
|
///
|
||||||
/// * `room` - The underlaying room.
|
/// * `room` - The underlying room.
|
||||||
pub fn new(client: Client, room: BaseRoom) -> Option<Self> {
|
pub fn new(client: Client, room: BaseRoom) -> Option<Self> {
|
||||||
// TODO: Make this private
|
// TODO: Make this private
|
||||||
if room.room_type() == RoomType::Joined {
|
if room.room_type() == RoomType::Joined {
|
||||||
|
|
|
@ -7,7 +7,7 @@ use crate::{room::Common, BaseRoom, Client, Result, RoomType};
|
||||||
/// A room in the left state.
|
/// A room in the left state.
|
||||||
///
|
///
|
||||||
/// This struct contains all methodes specific to a `Room` with type
|
/// This struct contains all methodes specific to a `Room` with type
|
||||||
/// `RoomType::Left`. Operations may fail once the underlaying `Room` changes
|
/// `RoomType::Left`. Operations may fail once the underlying `Room` changes
|
||||||
/// `RoomType`.
|
/// `RoomType`.
|
||||||
#[derive(Debug, Clone)]
|
#[derive(Debug, Clone)]
|
||||||
pub struct Left {
|
pub struct Left {
|
||||||
|
@ -15,13 +15,13 @@ pub struct Left {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Left {
|
impl Left {
|
||||||
/// Create a new `room::Left` if the underlaying `Room` has type
|
/// Create a new `room::Left` if the underlying `Room` has type
|
||||||
/// `RoomType::Left`.
|
/// `RoomType::Left`.
|
||||||
///
|
///
|
||||||
/// # Arguments
|
/// # Arguments
|
||||||
/// * `client` - The client used to make requests.
|
/// * `client` - The client used to make requests.
|
||||||
///
|
///
|
||||||
/// * `room` - The underlaying room.
|
/// * `room` - The underlying room.
|
||||||
pub fn new(client: Client, room: BaseRoom) -> Option<Self> {
|
pub fn new(client: Client, room: BaseRoom) -> Option<Self> {
|
||||||
// TODO: Make this private
|
// TODO: Make this private
|
||||||
if room.room_type() == RoomType::Left {
|
if room.room_type() == RoomType::Left {
|
||||||
|
|
Loading…
Reference in New Issue