Struct Line

pub struct Line {
    pub tags: HashMap<String, String>,
    pub source: Option<String>,
    pub command: String,
    pub params: Vec<String>,
}

A struct representing a parsed line.

Fields

tags: HashMap<String, String>

This line’s tags. This will be an empty hashmap if there are none.

source: Option<String>

This line’s source (including the nick, user, and host). This is optional, and will be None if not provided.

command: String

This line’s command.

params: Vec<String>

Any parameters passed to the command. This will be an empty vector if there are none.

Implementations

impl Line

pub fn new( tags: HashMap<String, String>, source: Option<String>, command: &str, params: Vec<String>, ) -> Self

Creates a new Line. You should never call this directly, but instead use the ircparser::parse function.

Arguments

• tags - This line’s tags. = source - This line’s source, or None if not to be provided.
• command - This line’s command.
• params - Any parameters passed to the command.

Returns

• Line - The new Line instance.

Example

use std::collections::HashMap;

let mut tags: HashMap<String, String> = HashMap::new();
tags.insert("id".to_string(), "123".to_string());

let source = Some(":nick!user@host.tmi.twitch.tv".to_string());
let command = "PRIVMSG";
let params = vec!["#rickastley".to_string()];

let line = ircparser::Line::new(tags, source, command, params);

assert_eq!(&line.tags["id"], "123");
assert_eq!(line.source.unwrap(), ":nick!user@host.tmi.twitch.tv");
assert_eq!(line.command, "PRIVMSG");
assert_eq!(line.params[0], "#rickastley");

Trait Implementations

impl Clone for Line

fn clone(&self) -> Line

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Line

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

Formats the value using the given formatter.

impl Default for Line

fn default() -> Line

Returns the “default value” for a type.