Struct hyperion::api::json::message::HyperionResponse

pub struct HyperionResponse {
    success: bool,
    tan: Option<i32>,
    error: Option<String>,
    info: Option<HyperionResponseInfo>,
}

Fields

success: bool

tan: Option<i32>

error: Option<String>

info: Option<HyperionResponseInfo>

Implementations

impl HyperionResponse

pub fn with_tan(self, tan: Option<i32>) -> Self

fn success_info(info: HyperionResponseInfo) -> Self

pub fn success() -> Self

Return a success response

pub fn error(error: impl Display) -> Self

Return an error response

pub fn error_info(error: impl Display, info: HyperionResponseInfo) -> Self

Return an error response

pub fn server_info( priorities: Vec<PriorityInfo>, adjustment: Vec<ChannelAdjustment>, effects: Vec<EffectDefinition>, instances: Vec<InstanceInfo> ) -> Self

Return a server information response

pub fn admin_required(admin_required: bool) -> Self

pub fn token_required(required: bool) -> Self

pub fn sys_info(id: Uuid) -> Self

pub fn switch_to(id: Option<i32>) -> Self

Trait Implementations

impl Debug for HyperionResponse

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

Formats the value using the given formatter.

impl Encoder<HyperionResponse> for JsonCodec

type Error = JsonCodecError

The type of encoding errors.

fn encode( &mut self, item: HyperionResponse, dst: &mut BytesMut ) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.

impl Serialize for HyperionResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.