Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.Yaml.Marked

Contents

Interop with Data.Yaml

Synopsis

data Marked a = Marked {
- markedItem :: a
- markedPath :: FilePath
- markedJSONPath :: Maybe JSONPath
- markedLocationStart :: Location
- markedLocationEnd :: Location
}
data Location = Location {
- locationIndex :: Natural
- locationLine :: Natural
- locationColumn :: Natural
}
data MarkedEvent
fromMarkedEvent :: MarkedEvent -> FilePath -> Marked Event

Documentation

data Marked a Source #

Constructors

Marked

Fields

markedItem :: a
markedPath :: FilePath
markedJSONPath :: Maybe JSONPath
markedLocationStart :: Location
Location of the first character of the item
In the following example, marking value will have a start location:
```
key: valuen
     ^-- HERE
```
markedLocationEnd :: Location
Location of the first character after the item
In the following example, marking value will have an end location:
```
key: valuen
          ^-- HERE
```

Instances

Instances details

Foldable Marked Source #
Instance details Defined in Data.Yaml.Marked Methods fold :: Monoid m => Marked m -> m # foldMap :: Monoid m => (a -> m) -> Marked a -> m # foldMap' :: Monoid m => (a -> m) -> Marked a -> m # foldr :: (a -> b -> b) -> b -> Marked a -> b # foldr' :: (a -> b -> b) -> b -> Marked a -> b # foldl :: (b -> a -> b) -> b -> Marked a -> b # foldl' :: (b -> a -> b) -> b -> Marked a -> b # foldr1 :: (a -> a -> a) -> Marked a -> a # foldl1 :: (a -> a -> a) -> Marked a -> a # toList :: Marked a -> [a] # null :: Marked a -> Bool # length :: Marked a -> Int # elem :: Eq a => a -> Marked a -> Bool # maximum :: Ord a => Marked a -> a # minimum :: Ord a => Marked a -> a # sum :: Num a => Marked a -> a # product :: Num a => Marked a -> a #
Traversable Marked Source #
Instance details Defined in Data.Yaml.Marked Methods traverse :: Applicative f => (a -> f b) -> Marked a -> f (Marked b) # sequenceA :: Applicative f => Marked (f a) -> f (Marked a) # mapM :: Monad m => (a -> m b) -> Marked a -> m (Marked b) # sequence :: Monad m => Marked (m a) -> m (Marked a) #
Functor Marked Source #
Instance details Defined in Data.Yaml.Marked Methods fmap :: (a -> b) -> Marked a -> Marked b # (<$) :: a -> Marked b -> Marked a #
Show a => Show (Marked a) Source #
Instance details Defined in Data.Yaml.Marked Methods showsPrec :: Int -> Marked a -> ShowS # show :: Marked a -> String # showList :: [Marked a] -> ShowS #
Eq a => Eq (Marked a) Source #
Instance details Defined in Data.Yaml.Marked Methods (==) :: Marked a -> Marked a -> Bool # (/=) :: Marked a -> Marked a -> Bool #

data Location Source #

Index, line, and column of a character

NB. All values are 0-based.

Constructors

Location
Fields locationIndex :: Natural locationLine :: Natural locationColumn :: Natural

Instances

Instances details

Show Location Source #
Instance details Defined in Data.Yaml.Marked Methods showsPrec :: Int -> Location -> ShowS # show :: Location -> String # showList :: [Location] -> ShowS #
Eq Location Source #
Instance details Defined in Data.Yaml.Marked Methods (==) :: Location -> Location -> Bool # (/=) :: Location -> Location -> Bool #

Interop with Data.Yaml

data MarkedEvent #

Event with start and end marks.

Since: libyaml-0.10.4.0

fromMarkedEvent :: MarkedEvent -> FilePath -> Marked Event Source #