Struct SinkholeRoles 

pub struct SinkholeRoles<'a> { /* private fields */ }

Sinkhole rule routes, from Client::sinkhole_roles (Core calls rules “roles”).

Only the list’s owner (or an Admin) may read or change rules, also for a shared list. To address rules by pattern instead of uuid, see ops::select_sinkhole_roles.

Implementations

impl<'a> SinkholeRoles<'a>

pub async fn get(&self, uuid: Uuid) -> Result<SinkholeRole>

One rule.

GET /api/v1/sinkhole-roles/:uuid

Errors

• ErrorCode::NotFound if there is no such rule.
• ErrorCode::Forbidden if its list belongs to another user.

pub async fn create(&self, role: &NewSinkholeRole) -> Result<SinkholeRole>

Adds a rule to a list; Relay applies it to every linked client. Returns the rule with the pattern as stored (names lowercased, no trailing dot).

POST /api/v1/sinkhole-roles

Errors

• ErrorCode::Validation if the pattern does not fit the type.
• ErrorCode::NotFound if the list does not exist.
• ErrorCode::Forbidden if it belongs to another user.

pub async fn update( &self, uuid: Uuid, patch: &SinkholeRolePatch, ) -> Result<SinkholeRole>

Changes a rule’s type and/or pattern; fields left None stay as they are.

PATCH /api/v1/sinkhole-roles/:uuid

Errors

• ErrorCode::NotFound if there is no such rule.
• ErrorCode::Forbidden if its list belongs to another user.
• ErrorCode::Validation if the result would not fit together (e.g. type Wildcard with a pattern without *.).

pub async fn delete(&self, uuid: Uuid) -> Result<()>

Removes a rule from its list.

DELETE /api/v1/sinkhole-roles/:uuid

Errors

• ErrorCode::NotFound if there is no such rule.
• ErrorCode::Forbidden if its list belongs to another user.