Skip to main content

AuditQuery

Struct AuditQuery 

Source
#[non_exhaustive]
pub struct AuditQuery { pub on_behalf_of: PrincipalId, pub since: Option<i64>, pub method_prefix: Option<String>, pub cursor: Option<AuditCursor>, pub limit: usize, }
Expand description

One page request against the audit table.

Build with new (which enforces the user-principal invariant) and narrow with the with_* combinators. Every filter is conjunctive.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§on_behalf_of: PrincipalId

The human the rows must be attributable to — matched against record.sub. Always a PrincipalKind::User.

§since: Option<i64>

Inclusive lower bound on record.at (kamaji’s clock), when set.

§method_prefix: Option<String>

Literal prefix record.method must start with, when set. Not a glob and not a regex — W127’s “who deployed what” needs cloud.deploy, nothing richer.

§cursor: Option<AuditCursor>

Resume position from a previous page’s next_cursor.

§limit: usize

Page size, already clamped to 1..=MAX_AUDIT_PAGE_LIMIT.

Implementations§

Source§

impl AuditQuery

Source

pub fn new(on_behalf_of: PrincipalId) -> Result<Self, AuditQueryError>

New query for on_behalf_of, at the default page size.

Rejects a non-user principal — see AuditQueryError::OnBehalfOfNotUser.

Source

pub fn with_since(self, since: i64) -> Self

Source

pub fn with_method_prefix(self, prefix: impl Into<String>) -> Self

Source

pub fn with_cursor(self, cursor: AuditCursor) -> Self

Source

pub fn with_limit(self, limit: usize) -> Self

Set the page size, clamped to 1..=MAX_AUDIT_PAGE_LIMIT. Clamps rather than erroring: an over-large ?limit= is a client that wants “as much as you’ll give me”, and failing the whole request over it buys nothing.

Source

pub fn matches(&self, row: &AuditRow) -> bool

true if row satisfies every filter except the cursor position. Shared by the in-memory impl and available to any impl that can’t push the whole predicate into its backend.

Trait Implementations§

Source§

impl Clone for AuditQuery

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for AuditQuery

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for AuditQuery

Source§

impl PartialEq for AuditQuery

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for AuditQuery

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more