Uses of Interface
dev.sympho.modular_commands.api.command.result.CommandResult

Packages that use CommandResult

Package	Description
dev.sympho.modular_commands.api.command.handler	Handler interfaces used across the system.
dev.sympho.modular_commands.api.command.result	Interfaces defining the result of handling an invoked command.
dev.sympho.modular_commands.api.exception	Exceptions thrown by the system.
dev.sympho.modular_commands.api.permission	API for permission management.
dev.sympho.modular_commands.execute	Runtime system for executing commands defined through the API.

Uses of CommandResult in dev.sympho.modular_commands.api.command.handler

Methods in dev.sympho.modular_commands.api.command.handler that return types with arguments of type CommandResult

Modifier and Type	Method	Description
default Mono<CommandResult>	InvocationHandler.apply(C context)
Mono<CommandResult>	InvocationHandler.handle(C context)	Handles an invocation of the command.
default Mono<CommandResult>	InvocationHandler.handleWrapped(C context)	Handles an invocation of the command using InvocationHandler.handle(CommandContext), automatically converting any exception thrown in that method or issued in the resulting mono to an exception result (with the exception of a ResultException, which is unpacked into the contained result).

Methods in dev.sympho.modular_commands.api.command.handler with parameters of type CommandResult

Modifier and Type	Method	Description
default Mono<Boolean>	ResultHandler.apply(C context, CommandResult result)
Mono<Boolean>	ResultHandler.handle(C context, CommandResult result)	Handles the result of a command.

Uses of CommandResult in dev.sympho.modular_commands.api.command.result

Subinterfaces of CommandResult in dev.sympho.modular_commands.api.command.result

Modifier and Type	Interface	Description
interface	CommandError	The result from a command that fails to execute due to an internal error.
interface	CommandErrorException	An error result due to an exception being thrown.
interface	CommandFailure	The result from a command that fails to execute due to user error.
interface	CommandFailureArgument	Failure result due to an issue with the provided arguments.
interface	CommandFailureMessage	A failure result with a message to the user.
interface	CommandSuccess	The result from a command that ran successfully.
interface	CommandSuccessMessage	A successful result with a message to the user.

Classes in dev.sympho.modular_commands.api.command.result that implement CommandResult

Modifier and Type	Class	Description
final record	CommandFailureArgumentExtra	Failure result due to one or more argument being provided where one wasn't expected.
final record	CommandFailureArgumentInvalid	Failure result due to a provided argument being invalid.
final record	CommandFailureArgumentMissing	Failure result due to a required argument not being provided.
final record	UserMissingPermissions	A failure result due to the user having insufficient permissions.
final record	UserNotAllowed	A failure result due to the user not being part of a specific group.

Methods in dev.sympho.modular_commands.api.command.result that return CommandResult

Modifier and Type	Method	Description
static CommandResult	Results.errorR(String message)	Alias for Results.error(String) that casts to a plain Result to avoid Generics issues.
static CommandResult	Results.exceptionR(Throwable cause)	Alias for Results.exception(Throwable) that casts to a plain Result to avoid Generics issues.
static CommandResult	Results.failR()	Alias for Results.fail() that casts to a plain Result to avoid Generics issues.
static CommandResult	Results.failureR(String message)	Alias for Results.failure(String) that casts to a plain Result to avoid Generics issues.
static CommandResult	Results.okR()	Alias for Results.ok() that casts to a plain Result to avoid Generics issues.
static CommandResult	Results.successR(String message)	Alias for Results.success(String) that casts to a plain Result to avoid Generics issues.

Methods in dev.sympho.modular_commands.api.command.result that return types with arguments of type CommandResult

Modifier and Type	Method	Description
static Mono<CommandResult>	Results.errorMono(String message)	Generates a result indicating the command encountered an error.
static Mono<CommandResult>	Results.exceptionMono(Throwable cause)	Generates a result indicating the command encountered an error due to an exception.
static Mono<CommandResult>	Results.failMono()	Generates a result indicating the command failed with no further context.
static Mono<CommandResult>	Results.failureMono(String message)	Generates a result indicating the command failed with a message to the user.
static Mono<CommandResult>	Results.okMono()	Generates a result indicating the command executed successfully with no further context.
static Mono<CommandResult>	Results.successMono(String message)	Generates a result indicating the command executed successfully with a message to the user.

Uses of CommandResult in dev.sympho.modular_commands.api.exception

Methods in dev.sympho.modular_commands.api.exception that return CommandResult

Modifier and Type	Method	Description
CommandResult	ResultException.getResult()	Retrieves the execution result.

Constructors in dev.sympho.modular_commands.api.exception with parameters of type CommandResult

Modifier	Constructor	Description
	ResultException(CommandResult result)	Creates a new instance.

Uses of CommandResult in dev.sympho.modular_commands.api.permission

Methods in dev.sympho.modular_commands.api.permission that return types with arguments of type CommandResult

Modifier and Type	Method	Description
default Mono<CommandResult>	AccessValidator.validate(Group group)	Determines whether the invoking user in the current execution context (guild and channel) has access equivalent to the given group, otherwise generating an appropriate result.

Uses of CommandResult in dev.sympho.modular_commands.execute

Methods in dev.sympho.modular_commands.execute that return types with arguments of type CommandResult

Modifier and Type	Method	Description
Mono<CommandResult>	LazyContext.load()	Loads remaining internal state, making the context fully ready for use.
Mono<CommandResult>	InvocationValidator.validateAccess(AccessValidator validator, List<? extends Command<?>> chain)	Validates that the user that invoked a command has sufficient access to do so.
Mono<CommandResult>	InvocationValidator.validateSettings(E event, List<? extends Command<?>> chain)	Validates that a command invocation is appropriate as per the command's settings.