Network.MQTT.Topic

Topic and topic related utiilities.

Documentation

data Filter

An MQTT topic filter.

Instances

Eq Filter

Defined in Network.MQTT.Topic

Methods

(==) :: Filter -> Filter -> Bool

(/=) :: Filter -> Filter -> Bool

Ord Filter

Defined in Network.MQTT.Topic

Methods

compare :: Filter -> Filter -> Ordering

(<) :: Filter -> Filter -> Bool

(<=) :: Filter -> Filter -> Bool

(>) :: Filter -> Filter -> Bool

(>=) :: Filter -> Filter -> Bool

max :: Filter -> Filter -> Filter

min :: Filter -> Filter -> Filter

Show Filter

Defined in Network.MQTT.Topic

Methods

showsPrec :: Int -> Filter -> ShowS

show :: Filter -> String

showList :: [Filter] -> ShowS

IsString Filter

Defined in Network.MQTT.Topic

Methods

fromString :: String -> Filter

Semigroup Filter

Defined in Network.MQTT.Topic

Methods

(<>) :: Filter -> Filter -> Filter

sconcat :: NonEmpty Filter -> Filter

stimes :: Integral b => b -> Filter -> Filter

Arbitrary Filter

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen Filter

shrink :: Filter -> [Filter]

unFilter :: Filter -> Text

data Topic

An MQTT topic.

Instances

Eq Topic

Defined in Network.MQTT.Topic

Methods

(==) :: Topic -> Topic -> Bool

(/=) :: Topic -> Topic -> Bool

Ord Topic

Defined in Network.MQTT.Topic

Methods

compare :: Topic -> Topic -> Ordering

(<) :: Topic -> Topic -> Bool

(<=) :: Topic -> Topic -> Bool

(>) :: Topic -> Topic -> Bool

(>=) :: Topic -> Topic -> Bool

max :: Topic -> Topic -> Topic

min :: Topic -> Topic -> Topic

Show Topic

Defined in Network.MQTT.Topic

Methods

showsPrec :: Int -> Topic -> ShowS

show :: Topic -> String

showList :: [Topic] -> ShowS

IsString Topic

Defined in Network.MQTT.Topic

Methods

fromString :: String -> Topic

Semigroup Topic

Defined in Network.MQTT.Topic

Methods

(<>) :: Topic -> Topic -> Topic

sconcat :: NonEmpty Topic -> Topic

stimes :: Integral b => b -> Topic -> Topic

Arbitrary Topic

Defined in Network.MQTT.Arbitrary

Methods

arbitrary :: Gen Topic

shrink :: Topic -> [Topic]

unTopic :: Topic -> Text

match :: Filter -> Topic -> Bool

match returns true iff the given pattern can be matched by the specified Topic as defined in the MQTT 3.1.1 specification.

mkFilter :: Text -> Maybe Filter

mkFilter creates a filter from a text representation of a valid filter.

mkTopic :: Text -> Maybe Topic

mkTopic creates a topic from a text representation of a valid filter.

split :: Splittable a => a -> [a]

split separates a Filter or Topic into its /-separated components.

toFilter :: Topic -> Filter

Convert a Topic to a Filter as all Topics are valid Filters