Struct Strip 

pub struct Strip { /* private fields */ }

Stripping mode for PluginHandle::strip.

Implementations

impl Strip

pub const fn new() -> Strip

Creates a new Strip that, by default, strips no attributes.

Examples

use hexchat_unsafe_plugin::{PluginHandle, Strip};

fn strip_nothing(s: &str, ph: &PluginHandle<'_>) -> String {
    ph.strip(s, Strip::new())
}

pub const fn colors(self, strip: bool) -> Self

Sets whether to remove mIRC color attributes.

Examples

use hexchat_unsafe_plugin::{PluginHandle, Strip};

fn strip_colors(s: &str, ph: &PluginHandle<'_>) -> String {
    ph.strip(s, Strip::new().colors(true))
}

pub const fn formatting(self, strip: bool) -> Self

Sets whether to remove formatting attributes.

Examples

use hexchat_unsafe_plugin::{PluginHandle, Strip};

fn strip_formatting(s: &str, ph: &PluginHandle<'_>) -> String {
    ph.strip(s, Strip::new().formatting(true))
}

pub const fn hidden(self, strip: bool) -> Self

Sets whether to remove internal “hidden text” formatting attributes.

This is split from Self::formatting because these attributes are only processed when writing directly to a buffer - they’re for internal/plugin use. This tends to be useful when processing user or remote input and writing it directly to a buffer.

Examples

use hexchat_unsafe_plugin::{PluginHandle, Strip};

fn strip_hidden(s: &str, ph: &PluginHandle<'_>) -> String {
    ph.strip(s, Strip::new().hidden(true))
}

pub const fn all() -> Strip

Creates a new Strip that strips all strippable attributes.

Examples

use hexchat_unsafe_plugin::{PluginHandle, Strip};

fn strip_all(s: &str, ph: &PluginHandle<'_>) -> String {
    ph.strip(s, Strip::all())
}

Trait Implementations

impl Clone for Strip

fn clone(&self) -> Strip

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Strip

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

Formats the value using the given formatter.

impl Default for Strip

fn default() -> Strip

Returns the “default value” for a type.

impl Hash for Strip

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Strip

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Strip

impl Eq for Strip

impl StructuralPartialEq for Strip