miniview 0.6.0

Display an image within a (graphical) window. Callable from a CLI interface.
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
61
62
63
64
65
66
67
68

//! Errors which signal faulty behaviour.
//!
//! MiniView attempts to always return an error in case of faulty behaviour instead of crashing
//! by virtue of panicking.

use thiserror::Error;

/// The top-level error type
#[derive(Error, Debug)]
pub enum MiniViewError {
    /// Returned in case an empty input path is given
    #[error("No path to an image was provided.")]
    EmptyInputPath,

    /// Returned in case an image can not be loaded from a [`source`].
    ///
    /// [`source`]: ../enum.Source.html
    #[error(transparent)]
    FailedToImport(#[from] ImportError),

    /// Returned if the input mode could not be defined
    #[error("Unable to determine input mode.")]
    CliUnableToDetermineInputMode,

    /// Returned if inter-thread communication trough a multi-producer single-consumer channel
    /// failed
    #[error("Unable to signal window to stop showing")]
    SendStopError,

    /// Created when it was not possible to create a graphical window
    #[error("Unable to create a window to display the image.")]
    UnableToCreateWindow,

    /// Returned if an image could not be mapped to the texture which is shown by the image view
    /// in the window
    #[error("Unable to map the image to a texture.")]
    UnableToMapImage,

    /// Returned when a thread does not exit properly
    #[error("View thread exited improperly")]
    ViewThreadFailedToJoin,
}

/// Errors related to loading an image from a path or stream
#[derive(Error, Debug)]
pub enum ImportError {
    /// Returned when a path can't be found on the filesystem
    #[error("Provided path to image could not be found or loaded.")]
    OnPathNotFound,

    /// Returned when the program is unable to read from the stdin
    #[error("Unable to read from the stdin.")]
    OnStdinUnableToRead,

    /// Returned when the program expects a qualified path from the stdin, but the given path is empty  
    #[error("Given path to image was empty.")]
    OnStdinPathWasEmpty,

    /// Returned when the program expects an ordered stream of bytes (the formatted image) from the
    /// stdin, but the stdin did not receive any input
    #[error("Stdin was empty.")]
    OnStdinBytesStreamWasEmpty,

    /// Returned when the program expects an ordered stream of bytes (the formatted image) from the
    /// stdin, but the given bytes could not be decoded
    #[error("The input received from stdin could not be loaded.")]
    OnStdinBytesUnableToGuessOrLoadFormat,
}