dockerfile-parser 0.2.0-rc1

a Rust library for parsing, validating, and modifying Dockerfiles
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

// (C) Copyright 2019 Hewlett Packard Enterprise Development LP

use pest::iterators::Pair;
use snafu::Snafu;

use crate::parser::*;

#[derive(Debug, Snafu)]
#[snafu(visibility(pub(crate)))]
pub enum Error {
  #[snafu(display(
    "could not parse Dockerfile: {}", source
  ))]
  ParseError {
    source: pest::error::Error<Rule>
  },

  #[snafu(display(
    "unable to parse Dockerfile: {}", message
  ))]
  GenericParseError {
    message: String
  },

  #[snafu(display(
    "error unescaping string: {}", source
  ))]
  UnescapeError {
    source: enquote::Error
  },

  #[snafu(display(
    "unable to parse Dockerfile"
  ))]
  UnknownParseError,

  #[snafu(display(
    "unable to parse image reference '{}': {}", image, message
  ))]
  ImageParseError {
    image: String,
    message: String
  },

  #[snafu(display(
    "could not read Dockerfile: {}", source
  ))]
  ReadError {
    source: std::io::Error
  }
}

pub type Result<T, E = Error> = std::result::Result<T, E>;

/// Helper to create an unexpected token error.
pub(crate) fn unexpected_token(record: Pair<Rule>) -> Error {
  Error::GenericParseError {
    message: format!("unexpected token {:?}", record.as_rule())
  }
}