Enum RoomCommand 

pub(crate) enum RoomCommand {
    List {
        page: Option<usize>,
        exclude_disabled: bool,
        exclude_banned: bool,
        no_details: bool,
    },
    Info {
        room: OwnedRoomOrAliasId,
    },
    ListJoinedMembers {
        room_id: OwnedRoomId,
        local_only: bool,
    },
    Moderation(RoomModerationCommand),
    Alias(RoomAliasCommand),
    Directory(RoomDirectoryCommand),
    Exists {
        room_id: OwnedRoomId,
    },
    ClearSoftFailedEvents {
        room_id: OwnedRoomOrAliasId,
    },
    Delete {
        room_id: OwnedRoomId,
        force: bool,
    },
    PruneEmpty {
        force: bool,
    },
    ListExtremities {
        room_id: OwnedRoomOrAliasId,
    },
    PruneExtremities {
        room_id: OwnedRoomOrAliasId,
        target: Option<usize>,
        dry_run: bool,
    },
    PurgeUser {
        user_id: String,
        regex: bool,
        sole_member: bool,
        dry_run: bool,
    },
}

Variants

List

• List all rooms the server knows about

Fields

page: Option<usize>

exclude_disabled: bool

Excludes rooms that we have federation disabled with

exclude_banned: bool

Excludes rooms that we have banned

no_details: bool

Whether to only output room IDs without supplementary room information

Info

• Get general information about a room

Shows the room’s name, topic, canonical alias, local aliases, and admins (users with a power level greater than or equal to state_default).

Fields

room: OwnedRoomOrAliasId

Room ID or alias

ListJoinedMembers

• List joined members in a room

Fields

room_id: OwnedRoomId

local_only: bool

Lists only our local users in the specified room

Moderation(RoomModerationCommand)

• Manage moderation of remote or local rooms

Alias(RoomAliasCommand)

• Manage room aliases

Directory(RoomDirectoryCommand)

• Manage the room directory

Exists

• Check if we know about a room

Fields

room_id: OwnedRoomId

ClearSoftFailedEvents

• Clear stored soft-fail and policy decisions for a room

Changes stored moderation state so matching events are re-checked on the next delivery instead of waiting out the retry window. Does not replay or insert events.

Fields

room_id: OwnedRoomOrAliasId

Room ID or alias

Delete

• Delete room

Fields

room_id: OwnedRoomId

force: bool

PruneEmpty

• Prune empty rooms

Fields

force: bool

ListExtremities

• List a room’s forward extremities with a total

Fields

room_id: OwnedRoomOrAliasId

PruneExtremities

• Scored prune of a room’s forward extremities down to a target

Fields

room_id: OwnedRoomOrAliasId

target: Option<usize>

Target frontier size (default: forward_extremities_max, min 1)

dry_run: bool

Show the plan without writing

PurgeUser

• Delete every room a user is joined to

Useful for cleaning up after spam invitations or a faulty appservice registration. With –regex the argument is a pattern matched against every joined member of each room, so a whole namespace (e.g. @bot_[A-Za-z0-9]+:example\.com) can be cleared at once.

Fields

user_id: String

A user ID, or (with –regex) a pattern matched against the joined members of every room

regex: bool

Interpret user_id as a regular expression

sole_member: bool

Only delete rooms where the matched user is the only joined member

dry_run: bool

List the rooms that would be deleted without deleting them

Trait Implementations

impl Debug for RoomCommand

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

Formats the value using the given formatter.

impl FromArgMatches for RoomCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for RoomCommand

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand