Trait Endpoint 

pub trait Endpoint {
    type Output;

    // Required methods
    fn method(&self) -> &'static str;
    fn path(&self) -> String;

    // Provided methods
    fn query(&self) -> Vec<(String, String)> { ... }
    fn body(&self) -> Option<Value> { ... }
}

Generic description of a RomM API endpoint.

Implementations of this trait define the structure and behavior of a specific API call, including its HTTP method, path, query parameters, and body.

Required Associated Types

type Output

The expected output type of this endpoint, which must be deserializable from JSON.

Required Methods

fn method(&self) -> &'static str

Returns the HTTP method (e.g., “GET”, “POST”, “PUT”, “DELETE”).

fn path(&self) -> String

Returns the path relative to the base URL (e.g., “/api/roms”).

Provided Methods

fn query(&self) -> Vec<(String, String)>

Returns the query parameters as a list of key/value pairs. Defaults to an empty list.

fn body(&self) -> Option<Value>

Returns the optional JSON request body. Defaults to None.

Implementors

impl Endpoint for ExchangeClientToken

type Output = ClientTokenCreateSchema

impl Endpoint for DeleteManualCollection

type Output = Value

impl Endpoint for DeleteSmartCollection

type Output = Value

impl Endpoint for GetManualCollection

type Output = Value

impl Endpoint for GetSmartCollection

type Output = Value

impl Endpoint for GetVirtualCollection

type Output = Value

impl Endpoint for ListCollections

type Output = CollectionsList

impl Endpoint for ListSmartCollections

type Output = CollectionsList

impl Endpoint for ListVirtualCollections

type Output = Vec<VirtualCollectionRow>

impl Endpoint for DeletePlatform

type Output = Value

impl Endpoint for GetPlatform

type Output = Platform

impl Endpoint for ListPlatforms

type Output = Vec<Platform>

impl Endpoint for ListSupportedPlatforms

type Output = Value

impl Endpoint for PutPlatform

type Output = Value

impl Endpoint for DeleteRomNote

type Output = Value

impl Endpoint for DeleteRoms

type Output = Value

impl Endpoint for GetRom

type Output = Rom

impl Endpoint for GetRomByHash

type Output = Value

impl Endpoint for GetRomByMetadataProvider

type Output = Value

impl Endpoint for GetRomFilters

type Output = Value

impl Endpoint for GetRomNotes

type Output = Value

impl Endpoint for GetRoms

type Output = RomList

impl Endpoint for GetSearchCover

type Output = Value

impl Endpoint for GetSearchRoms

type Output = Value

impl Endpoint for PostRomNote

type Output = Value

impl Endpoint for PutRomNote

type Output = Value

impl Endpoint for PutRomUserProps

type Output = Value

impl Endpoint for GetHeartbeat

type Output = Value

impl Endpoint for GetStats

type Output = Value

impl Endpoint for GetUsersMe

type Output = Value

impl Endpoint for GetTasksStatus

type Output = Value

impl Endpoint for ListTasks

type Output = Value

impl Endpoint for RunAllTasks

type Output = Value