Data.Yaml.Marked.Replace

Documentation

data Replace

Instances

Show Replace

Defined in Data.Yaml.Marked.Replace

Methods

showsPrec :: Int -> Replace -> ShowS

show :: Replace -> String

showList :: [Replace] -> ShowS

Eq Replace

Defined in Data.Yaml.Marked.Replace

Methods

(==) :: Replace -> Replace -> Bool

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

newReplace :: Natural -> Natural -> ByteString -> Replace

Create a Replace directly at given index and length

NB. This function is unsafe in that it can be used with negative literals and will fail at runtime. Prefer replaceMarked.

replaceMarked :: Marked a -> ByteString -> Replace

Create a Replace for something Marked

data ReplaceException

Constructors

ReplaceOutOfBounds Replace Natural

OverlappingReplace Replace

Instances

Exception ReplaceException

Defined in Data.Yaml.Marked.Replace

Methods

toException :: ReplaceException -> SomeException

fromException :: SomeException -> Maybe ReplaceException

displayException :: ReplaceException -> String

Show ReplaceException

Defined in Data.Yaml.Marked.Replace

Methods

showsPrec :: Int -> ReplaceException -> ShowS

show :: ReplaceException -> String

showList :: [ReplaceException] -> ShowS

Eq ReplaceException

Defined in Data.Yaml.Marked.Replace

Methods

(==) :: ReplaceException -> ReplaceException -> Bool

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

runReplaces :: MonadThrow m => [Replace] -> ByteString -> m ByteString

runReplacesOnOverlapping

Arguments

:: MonadThrow m

=> (Replace -> m a)

What to do with the first overlapping Replace if encountered

NB. the overlapping replace(s) will be ignored, but this allows you to log it as a warning, or use throwM to halt (which runReplaces does).

-> [Replace]

-> ByteString

-> m ByteString