Enum trawler::LobstersRequest

pub enum LobstersRequest {
    Frontpage,
    Recent,
    Comments,
    User(UserId),
    Story(StoryId),
    Login,
    Logout,
    StoryVote(StoryId, Vote),
    CommentVote(CommentId, Vote),
    Submit {
        id: StoryId,
        title: String,
    },
    Comment {
        id: CommentId,
        story: StoryId,
        parent: Option<CommentId>,
    },
}

A single lobste.rs client request.

Note that one request may end up issuing multiple backend queries. To see which queries are executed by the real lobste.rs, see the lobste.rs source code.

Any request type that mentions an "acting" user is guaranteed to have the user argument to handle be Some.

Variants

Frontpage

Render the frontpage.

Recent

Render recently submitted stories.

Comments

Render recently submitted comments.

User(UserId)

Render a user's profile.

Note that the id here should be treated as a username.

Story(StoryId)

Render a particular story.

Login

Log in the acting user.

Note that a user need not be logged in by a LobstersRequest::Login in order for a user-action (like LobstersRequest::Submit) to be issued for that user. The id here should be considered both a username and an id. The user with the username derived from this id should have the given id.

Logout

Log out the acting user.

StoryVote(StoryId, Vote)

Have the acting user issue an up or down vote for the given story.

Note that the load generator does not guarantee that a given user will only issue a single vote for a given story, nor that they will issue an equivalent number of upvotes and downvotes for a given story.

CommentVote(CommentId, Vote)

Have the acting user issue an up or down vote for the given comment.

Note that the load generator does not guarantee that a given user will only issue a single vote for a given comment, nor that they will issue an equivalent number of upvotes and downvotes for a given comment.

Submit

Have the acting user submit a new story to the site.

Note that the generator dictates the ids of new stories so that it can more easily keep track of which stories exist, and thus which stories can be voted for or commented on.

Fields of Submit

id: StoryId

The new story's id.

title: String

The story's title.

Comment

Have the acting user submit a new comment to the given story.

Note that the generator dictates the ids of new comments so that it can more easily keep track of which comments exist for the purposes of generating comment votes and deeper threads.

Fields of Comment

id: CommentId

The new comment's id.

story: StoryId

The story the comment is for.

parent: Option<CommentId>

The id of the comment's parent comment, if any.

Implementations

impl LobstersRequest

pub fn all() -> IntoIter<Discriminant<Self>>

Enumerate all possible request types in a deterministic order.

pub fn variant_name(v: &Discriminant<Self>) -> &'static str

Give a textual representation of the given LobstersRequest discriminant.

Useful for printing the keys of the maps of histograms returned by run.

pub fn describe(&self) -> String

Produce a textual representation of this request.

These are on the form:

METHOD /path [params] <user>

Where:

• METHOD is GET or POST.
• /path is the approximate lobste.rs URL endpoint for the request.
• [params] are any additional params to the request such as id to assign or associate a new resource with with.

Trait Implementations

impl Clone for LobstersRequest

fn clone(&self) -> LobstersRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LobstersRequest

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

Formats the value using the given formatter.

impl Eq for LobstersRequest

impl Hash for LobstersRequest

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for LobstersRequest

fn cmp(&self, other: &LobstersRequest) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<LobstersRequest> for LobstersRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<LobstersRequest> for LobstersRequest

fn partial_cmp(&self, other: &LobstersRequest) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &LobstersRequest) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &LobstersRequest) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &LobstersRequest) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &LobstersRequest) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for LobstersRequest

impl StructuralPartialEq for LobstersRequest