var searchIndex = {};
searchIndex["immeta"] = {"doc":"immeta allows one to load metadata from files of various image formats.","items":[[3,"Dimensions","immeta","Represents image dimensions in pixels.",null,null],[12,"width","","Image width in pixels.",0,null],[12,"height","","Image height in pixels.",0,null],[4,"Error","","Library-specific error type which is returned by metadata loading operations.",null,null],[13,"InvalidFormat","","Returned when metadata can't be recovered because image format is invalid.",1,null],[13,"UnexpectedEndOfFile","","Returned when metadata can't be recovered because of the sudden end of the image file.",1,null],[13,"Io","","Returned when an I/O error occurs when reading an input stream.",1,null],[4,"GenericMetadata","","Represents metadata loaded from a file whose format was determined automatically.",null,null],[13,"Png","","",2,null],[13,"Gif","","",2,null],[13,"Jpeg","","",2,null],[13,"Webp","","",2,null],[5,"load","","Attempts to load metadata for an image contained in the provided input stream.",null,{"inputs":[{"name":"r"}],"output":{"name":"result"}}],[5,"load_from_file","","Attempts to load metadata for an image contained in a file identified by the provided path.",null,{"inputs":[{"name":"p"}],"output":{"name":"result"}}],[5,"load_from_buf","","Attempts to load metadata for an image contained in an in-memory buffer.",null,null],[0,"markers","","Contains metadata marker types.",null,null],[4,"Jpeg","immeta::markers","",null,null],[4,"Png","","",null,null],[4,"Gif","","",null,null],[4,"Webp","","",null,null],[8,"MetadataMarker","","A marker trait for specific metadata type.",null,null],[16,"Metadata","","",3,null],[10,"from_generic","","Tries to convert the given `GenericMetadata` instance into a concrete metadata type.",3,{"inputs":[{"name":"genericmetadata"}],"output":{"name":"result"}}],[10,"from_generic_ref","","Tries to extract a reference to a concrete metadata type from the given\n`GenericMetadata` reference.",3,{"inputs":[{"name":"genericmetadata"}],"output":{"name":"option"}}],[10,"load","","Attempts to load metadata for an image of a concrete type from the provided reader.",3,{"inputs":[{"name":"r"}],"output":{"name":"result"}}],[10,"load_from_file","","Attempts to load metadata for an image of a concrete type from a file identified\nby the provided path.",3,{"inputs":[{"name":"p"}],"output":{"name":"result"}}],[10,"load_from_buf","","Attempts to load metadata for an image of a concrete type from the provided byte\nbuffer.",3,null],[11,"from_generic","","",4,{"inputs":[{"name":"genericmetadata"}],"output":{"name":"result"}}],[11,"from_generic_ref","","",4,{"inputs":[{"name":"genericmetadata"}],"output":{"name":"option"}}],[11,"load","","",4,{"inputs":[{"name":"r"}],"output":{"name":"result"}}],[11,"load_from_file","","",4,{"inputs":[{"name":"p"}],"output":{"name":"result"}}],[11,"load_from_buf","","",4,null],[11,"from_generic","","",5,{"inputs":[{"name":"genericmetadata"}],"output":{"name":"result"}}],[11,"from_generic_ref","","",5,{"inputs":[{"name":"genericmetadata"}],"output":{"name":"option"}}],[11,"load","","",5,{"inputs":[{"name":"r"}],"output":{"name":"result"}}],[11,"load_from_file","","",5,{"inputs":[{"name":"p"}],"output":{"name":"result"}}],[11,"load_from_buf","","",5,null],[11,"from_generic","","",6,{"inputs":[{"name":"genericmetadata"}],"output":{"name":"result"}}],[11,"from_generic_ref","","",6,{"inputs":[{"name":"genericmetadata"}],"output":{"name":"option"}}],[11,"load","","",6,{"inputs":[{"name":"r"}],"output":{"name":"result"}}],[11,"load_from_file","","",6,{"inputs":[{"name":"p"}],"output":{"name":"result"}}],[11,"load_from_buf","","",6,null],[11,"from_generic","","",7,{"inputs":[{"name":"genericmetadata"}],"output":{"name":"result"}}],[11,"from_generic_ref","","",7,{"inputs":[{"name":"genericmetadata"}],"output":{"name":"option"}}],[11,"load","","",7,{"inputs":[{"name":"r"}],"output":{"name":"result"}}],[11,"load_from_file","","",7,{"inputs":[{"name":"p"}],"output":{"name":"result"}}],[11,"load_from_buf","","",7,null],[11,"eq","immeta","",2,null],[11,"ne","","",2,null],[11,"clone","","",2,null],[11,"fmt","","",2,null],[11,"dimensions","","Returns image dimensions from the contained metadata.",2,null],[11,"mime_type","","Returns a MIME type string for the image type of the contained metadata.",2,null],[11,"into","","Attemts to convert this value to the specific metadata type by value.",2,null],[11,"as_ref","","Attempts to convert this value to the sepcific metadata type by reference.",2,null],[11,"fmt","","",1,null],[11,"fmt","","",1,null],[11,"description","","",1,null],[11,"cause","","",1,null],[11,"from","","",1,{"inputs":[{"name":"error"}],"output":{"name":"error"}}],[11,"from","","",1,{"inputs":[{"name":"error"}],"output":{"name":"error"}}],[11,"fmt","","",0,null],[11,"eq","","",0,null],[11,"ne","","",0,null],[11,"clone","","",0,null],[11,"from","","",0,null],[0,"common","","",null,null],[0,"riff","immeta::common","",null,null],[3,"ChunkId","immeta::common::riff","",null,null],[12,"0","","",8,null],[3,"RiffReader","","",null,null],[3,"RiffChunk","","",null,null],[3,"RiffListChunk","","",null,null],[11,"fmt","","",8,null],[11,"eq","","",8,null],[11,"ne","","",8,null],[11,"clone","","",8,null],[11,"as_str","","",8,null],[11,"as_bytes","","",8,null],[11,"fmt","","",8,null],[11,"new","","",9,{"inputs":[{"name":"r"}],"output":{"name":"riffreader"}}],[11,"root","","",9,null],[11,"chunk_id","","",10,null],[11,"len","","",10,null],[11,"contents","","",10,null],[11,"can_have_subchunks","","",10,null],[11,"into_list","","",10,null],[11,"chunk_id","","",11,null],[11,"len","","",11,null],[11,"chunk_type","","",11,null],[11,"next","","",11,null],[0,"formats","immeta","Supported image types.",null,null],[0,"jpeg","immeta::formats","Metadata of JPEG images.",null,null],[3,"Metadata","immeta::formats::jpeg","Represents metadata of a JPEG image.",null,null],[12,"dimensions","","Image size.",12,null],[11,"fmt","","",12,null],[11,"eq","","",12,null],[11,"ne","","",12,null],[11,"clone","","",12,null],[11,"load","","",12,{"inputs":[{"name":"r"}],"output":{"name":"result"}}],[0,"png","immeta::formats","Metadata for PNG images.",null,null],[3,"Metadata","immeta::formats::png","Represents metadata of a PNG image.",null,null],[12,"dimensions","","Width and height.",13,null],[12,"color_type","","Color type used in the image.",13,null],[12,"color_depth","","Color depth (bits per pixel) used in the image.",13,null],[12,"compression_method","","Compression method used in the image.",13,null],[12,"filter_method","","Preprocessing method used in the image.",13,null],[12,"interlace_method","","Transmission order used in the image.",13,null],[4,"ColorType","","Color type used in an image.",null,null],[13,"Grayscale","","",14,null],[13,"Rgb","","",14,null],[13,"Indexed","","",14,null],[13,"GrayscaleAlpha","","",14,null],[13,"RgbAlpha","","",14,null],[4,"CompressionMethod","","Compression method used in an image.",null,null],[13,"DeflateInflate","","",15,null],[4,"FilterMethod","","Filtering method used in an image.",null,null],[13,"AdaptiveFiltering","","",16,null],[4,"InterlaceMethod","","Interlace method used in an image.",null,null],[13,"Disabled","","",17,null],[13,"Adam7","","",17,null],[11,"fmt","","",14,null],[11,"eq","","",14,null],[11,"clone","","",14,null],[11,"fmt","","",15,null],[11,"eq","","",15,null],[11,"clone","","",15,null],[11,"fmt","","",16,null],[11,"eq","","",16,null],[11,"clone","","",16,null],[11,"fmt","","",17,null],[11,"eq","","",17,null],[11,"clone","","",17,null],[11,"fmt","","",13,null],[11,"eq","","",13,null],[11,"ne","","",13,null],[11,"clone","","",13,null],[11,"load","","",13,{"inputs":[{"name":"r"}],"output":{"name":"result"}}],[0,"gif","immeta::formats","Metadata of GIF images.",null,null],[3,"ColorTable","immeta::formats::gif","Contains information about a color table (global or local).",null,null],[12,"size","","Color table size, between 2 and 256.",18,null],[12,"sorted","","Whether the color table is sorted. Quoting from GIF spec:",18,null],[3,"ImageDescriptor","","Contains metadata about an image block, i.e. a single frame of a GIF image.",null,null],[12,"left","","Offset of the image data from the left boundary of the logical screen.",19,null],[12,"top","","Offset of the image data from the top boundary of the logical screen.",19,null],[12,"width","","Width of the image data.",19,null],[12,"height","","Height of the image data.",19,null],[12,"local_color_table","","Information about local color table, if it is present.",19,null],[12,"interlace","","Whether the image is interlaced.",19,null],[3,"GraphicControlExtension","","Contains metadata for a graphic control extension block.",null,null],[12,"disposal_method","","Indicates how the graphic should be treated after it is displayed.",20,null],[12,"user_input","","Whether or not user input is required before continuing.",20,null],[12,"transparent_color_index","","Specifies "transparent" color in a color table, if available.",20,null],[12,"delay_time","","Defines the delay before processing the rest of the GIF stream.",20,null],[3,"PlainTextExtension","","Contains metadata for a plain text extension block.",null,null],[12,"left","","Column number, in pixels, of the left edge of the text grid, with respect to\nthe left edge of the logical screen.",21,null],[12,"top","","Same as above, for the top edges.",21,null],[12,"width","","Width of the text grid in pixels.",21,null],[12,"height","","Height of the text grid in pixels.",21,null],[12,"cell_width","","Width in pixels of each cell in the text grid.",21,null],[12,"cell_height","","Height in pixels of each cell in the text grid.",21,null],[12,"foreground_color_index","","Index of a foreground color in the global color table.",21,null],[12,"background_color_index","","Index of a background color in the global color table.",21,null],[3,"ApplicationExtension","","Contains metadata for application extension block.",null,null],[12,"application_identifier","","Eight ASCII bytes of an application identifier.",22,null],[12,"authentication_code","","Three bytes of an application authentication code.",22,null],[3,"CommentExtension","","Represents a comment extension block.",null,null],[3,"Metadata","","Contains metadata about the whole GIF image.",null,null],[12,"version","","GIF format version from the file header.",23,null],[12,"dimensions","","Logical screen dimensions of the image.",23,null],[12,"global_color_table","","Information about global color table, if it is present.",23,null],[12,"color_resolution","","Number of colors available to the original image.",23,null],[12,"background_color_index","","Index of the default background color in the global color table.",23,null],[12,"pixel_aspect_ratio","","A factor which defines the aspect ration of a pixel in the original image.",23,null],[12,"blocks","","Metadata for each block in the GIF image.",23,null],[4,"Version","","GIF file version number.",null,null],[13,"V87a","","",24,null],[13,"V89a","","",24,null],[4,"Block","","Represents various kinds of blocks which can be used in a GIF image.",null,null],[13,"ImageDescriptor","","An image descriptor (image contents for one frame).",25,null],[13,"GraphicControlExtension","","Graphics control metadata block (e.g. frame delay or transparency).",25,null],[13,"PlainTextExtension","","Plain text block (textual data that can be displayed as an image).",25,null],[13,"ApplicationExtension","","Application information block (contains information about application which created the\nimage).",25,null],[13,"CommentExtension","","Comment block (contains commentary data which is not displayed in the image).",25,null],[4,"DisposalMethod","","Describes disposal methods used for GIF image frames.",null,null],[13,"None","","The decoder is not required to take any action.",26,null],[13,"DoNotDispose","","The graphic is to be left in place.",26,null],[13,"RestoreToBackgroundColor","","The area used by the graphic must be restored to the background color.",26,null],[13,"RestoreToPrevious","","The decoder is required to restore the area overwritten by the graphic with what\nwas there prior to rendering the graphic.",26,null],[13,"Unknown","","Unknown disposal method.",26,null],[11,"fmt","","",24,null],[11,"eq","","",24,null],[11,"clone","","",24,null],[11,"fmt","","",25,null],[11,"eq","","",25,null],[11,"ne","","",25,null],[11,"clone","","",25,null],[11,"fmt","","",18,null],[11,"eq","","",18,null],[11,"ne","","",18,null],[11,"clone","","",18,null],[11,"fmt","","",19,null],[11,"eq","","",19,null],[11,"ne","","",19,null],[11,"clone","","",19,null],[11,"fmt","","",20,null],[11,"eq","","",20,null],[11,"ne","","",20,null],[11,"clone","","",20,null],[11,"delay_time_ms","","Returns delay time in milliseconds.",20,null],[11,"fmt","","",26,null],[11,"eq","","",26,null],[11,"ne","","",26,null],[11,"clone","","",26,null],[11,"fmt","","",21,null],[11,"eq","","",21,null],[11,"ne","","",21,null],[11,"clone","","",21,null],[11,"fmt","","",22,null],[11,"eq","","",22,null],[11,"ne","","",22,null],[11,"clone","","",22,null],[11,"application_identifier_str","","Returns application identifier as a UTF-8 string, if possible.",22,null],[11,"authentication_code_str","","Returns authentication code as a UTF-8 string, if possible.",22,null],[11,"fmt","","",27,null],[11,"eq","","",27,null],[11,"clone","","",27,null],[11,"fmt","","",23,null],[11,"eq","","",23,null],[11,"ne","","",23,null],[11,"clone","","",23,null],[11,"pixel_aspect_ratio_approx","","Computes pixel aspect ratio approximation, if it is available.",23,null],[11,"frames_number","","Computes the number of frames, i.e. the number of image descriptor blocks.",23,null],[11,"is_animated","","Returns `true` if the image is animated, `false` otherwise.",23,null],[11,"load","","",23,{"inputs":[{"name":"r"}],"output":{"name":"result"}}],[0,"webp","immeta::formats","",null,null],[3,"VP8Metadata","immeta::formats::webp","",null,null],[12,"version_number","","",28,null],[12,"show_frame","","",28,null],[12,"first_partition_len","","",28,null],[12,"frame","","",28,null],[3,"VP8LMetadata","","",null,null],[3,"VP8XMetadata","","",null,null],[4,"Metadata","","",null,null],[13,"VP8","","",29,null],[13,"VP8L","","",29,null],[13,"VP8X","","",29,null],[4,"VP8Frame","","",null,null],[13,"Key","","",30,null],[12,"dimensions","immeta::formats::webp::VP8Frame","",30,null],[12,"x_scale","","",30,null],[12,"y_scale","","",30,null],[13,"Inter","immeta::formats::webp","",30,null],[11,"fmt","","",29,null],[11,"eq","","",29,null],[11,"ne","","",29,null],[11,"clone","","",29,null],[11,"fmt","","",28,null],[11,"eq","","",28,null],[11,"ne","","",28,null],[11,"clone","","",28,null],[11,"fmt","","",30,null],[11,"eq","","",30,null],[11,"ne","","",30,null],[11,"clone","","",30,null],[11,"fmt","","",31,null],[11,"eq","","",31,null],[11,"clone","","",31,null],[11,"fmt","","",32,null],[11,"eq","","",32,null],[11,"clone","","",32,null],[11,"dimensions","","",29,null],[11,"load","","",29,{"inputs":[{"name":"r"}],"output":{"name":"result"}}],[6,"Result","immeta","Library-specific result type.",null,null],[8,"LoadableMetadata","","Provides several convenience functions for loading metadata from various sources.",null,null],[10,"load","","Loads the implementing type from the given input stream.",33,{"inputs":[{"name":"r"}],"output":{"name":"result"}}],[11,"load_from_file","","Loads the implementing type from a file specified by the given path.",33,{"inputs":[{"name":"p"}],"output":{"name":"result"}}],[11,"load_from_buf","","Loads the implementing type from an in-memory buffer.",33,null],[11,"load_from_file","","Loads the implementing type from a file specified by the given path.",33,{"inputs":[{"name":"p"}],"output":{"name":"result"}}],[11,"load_from_buf","","Loads the implementing type from an in-memory buffer.",33,null]],"paths":[[3,"Dimensions"],[4,"Error"],[4,"GenericMetadata"],[8,"MetadataMarker"],[4,"Jpeg"],[4,"Png"],[4,"Gif"],[4,"Webp"],[3,"ChunkId"],[3,"RiffReader"],[3,"RiffChunk"],[3,"RiffListChunk"],[3,"Metadata"],[3,"Metadata"],[4,"ColorType"],[4,"CompressionMethod"],[4,"FilterMethod"],[4,"InterlaceMethod"],[3,"ColorTable"],[3,"ImageDescriptor"],[3,"GraphicControlExtension"],[3,"PlainTextExtension"],[3,"ApplicationExtension"],[3,"Metadata"],[4,"Version"],[4,"Block"],[4,"DisposalMethod"],[3,"CommentExtension"],[3,"VP8Metadata"],[4,"Metadata"],[4,"VP8Frame"],[3,"VP8LMetadata"],[3,"VP8XMetadata"],[8,"LoadableMetadata"]]};
initSearch(searchIndex);