Struct QueueName 

pub struct QueueName { /* private fields */ }

A named queue backed by a PostgreSQL table.

Each QueueName maps to a table called queue_{name}. Create the table using the pg_queue_create_queue() SQL function from migrations/setup.sql.

Names must be non-empty and contain only ASCII alphanumerics or underscores.

Example

use pg_queue::QueueName;

let emails = QueueName::new("emails").unwrap();
assert_eq!(emails.table_name(), "queue_emails");

Implementations

impl QueueName

pub fn new(name: impl Into<String>) -> Result<Self>

pub fn table_name(&self) -> String

Returns the backing table name: queue_{name}

pub fn channel_name(&self) -> String

Returns the NOTIFY channel name (same as table name by convention)

pub fn name(&self) -> &str

Returns the raw queue name

Trait Implementations

impl Clone for QueueName

fn clone(&self) -> QueueName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueueName

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

Formats the value using the given formatter.

impl Display for QueueName

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

Formats the value using the given formatter.

impl Hash for QueueName

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 QueueName

fn eq(&self, other: &QueueName) -> 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 Eq for QueueName

impl StructuralPartialEq for QueueName