var searchIndex = {};
searchIndex["tar"] = {"doc":"A library for reading and writing TAR archives","items":[[3,"Header","tar","Representation of the header of an entry in an archive",null,null],[3,"OldHeader","","Representation of the header of an entry in an archive",null,null],[12,"name","","",0,null],[12,"mode","","",0,null],[12,"uid","","",0,null],[12,"gid","","",0,null],[12,"size","","",0,null],[12,"mtime","","",0,null],[12,"cksum","","",0,null],[12,"linkflag","","",0,null],[12,"linkname","","",0,null],[12,"pad","","",0,null],[3,"UstarHeader","","Representation of the header of an entry in an archive",null,null],[12,"name","","",1,null],[12,"mode","","",1,null],[12,"uid","","",1,null],[12,"gid","","",1,null],[12,"size","","",1,null],[12,"mtime","","",1,null],[12,"cksum","","",1,null],[12,"typeflag","","",1,null],[12,"linkname","","",1,null],[12,"magic","","",1,null],[12,"version","","",1,null],[12,"uname","","",1,null],[12,"gname","","",1,null],[12,"dev_major","","",1,null],[12,"dev_minor","","",1,null],[12,"prefix","","",1,null],[12,"pad","","",1,null],[3,"GnuHeader","","Representation of the header of an entry in an archive",null,null],[12,"name","","",2,null],[12,"mode","","",2,null],[12,"uid","","",2,null],[12,"gid","","",2,null],[12,"size","","",2,null],[12,"mtime","","",2,null],[12,"cksum","","",2,null],[12,"typeflag","","",2,null],[12,"linkname","","",2,null],[12,"magic","","",2,null],[12,"version","","",2,null],[12,"uname","","",2,null],[12,"gname","","",2,null],[12,"dev_major","","",2,null],[12,"dev_minor","","",2,null],[12,"atime","","",2,null],[12,"ctime","","",2,null],[12,"offset","","",2,null],[12,"longnames","","",2,null],[12,"unused","","",2,null],[12,"sparse","","",2,null],[12,"isextended","","",2,null],[12,"realsize","","",2,null],[12,"pad","","",2,null],[3,"GnuSparseHeader","","Description of the header of a spare entry.",null,null],[12,"offset","","",3,null],[12,"numbytes","","",3,null],[3,"GnuExtSparseHeader","","Representation of the entry found to represent extended GNU sparse files.",null,null],[12,"sparse","","",4,null],[12,"isextended","","",4,null],[12,"padding","","",4,null],[3,"Entry","","A read-only view into an entry of an archive.",null,null],[3,"Archive","","A top-level representation of an archive file.",null,null],[3,"Entries","","An iterator over the entries of an archive.",null,null],[3,"Builder","","A structure for building archives",null,null],[3,"PaxExtensions","","An iterator over the pax extensions in an archive entry.",null,null],[3,"PaxExtension","","A key/value pair corresponding to a pax extension.",null,null],[4,"EntryType","","Indicate for the type of file described by a header.",null,null],[13,"Regular","","Regular file",5,null],[13,"Link","","Hard link",5,null],[13,"Symlink","","Symbolic link",5,null],[13,"Char","","Character device",5,null],[13,"Block","","Block device",5,null],[13,"Directory","","Directory",5,null],[13,"Fifo","","Named pipe (fifo)",5,null],[13,"Continuous","","Implementation-defined 'high-performance' type, treated as regular file",5,null],[13,"GNULongName","","GNU extension - long file name",5,null],[13,"GNULongLink","","GNU extension - long link name (link target)",5,null],[13,"GNUSparse","","GNU extension - sparse file",5,null],[13,"XGlobalHeader","","Global extended header",5,null],[13,"XHeader","","Extended Header",5,null],[11,"new","","Create a new archive with the underlying object as the reader.",6,{"inputs":[{"name":"r"}],"output":{"name":"archive"}}],[11,"into_inner","","Unwrap this archive, returning the underlying object.",6,null],[11,"entries","","Construct an iterator over the entries in this archive.",6,null],[11,"unpack","","Unpacks the contents tarball into the specified `dst`.",6,null],[11,"raw","","Indicates whether this iterator will return raw entries or not.",7,null],[11,"next","","",7,null],[11,"new","","Create a new archive builder with the underlying object as the\ndestination of all data written.",8,{"inputs":[{"name":"w"}],"output":{"name":"builder"}}],[11,"into_inner","","Unwrap this archive, returning the underlying object.",8,null],[11,"append","","Adds a new entry to this archive.",8,null],[11,"append_path","","Adds a file on the local filesystem to this archive.",8,null],[11,"append_file","","Adds a file to this archive with the given path as the name of the file\nin the archive.",8,null],[11,"append_dir","","Adds a directory to this archive with the given path as the name of the\ndirectory in the archive.",8,null],[11,"finish","","Finish writing this archive, emitting the termination sections.",8,null],[11,"drop","","",8,null],[11,"path","","Returns the path name for this entry.",9,null],[11,"path_bytes","","Returns the raw bytes listed for this entry.",9,null],[11,"link_name","","Returns the link name for this entry, if any is found.",9,null],[11,"link_name_bytes","","Returns the link name for this entry, in bytes, if listed.",9,null],[11,"pax_extensions","","Returns an iterator over the pax extensions contained in this entry.",9,null],[11,"header","","Returns access to the header of this entry in the archive.",9,null],[11,"unpack","","Writes this file to the specified location.",9,null],[11,"read","","",9,null],[11,"fmt","","",5,null],[11,"eq","","",5,null],[11,"ne","","",5,null],[11,"clone","","",5,null],[11,"new","","Creates a new entry type from a raw byte.",5,{"inputs":[{"name":"u8"}],"output":{"name":"entrytype"}}],[11,"as_byte","","Returns the raw underlying byte that this entry type represents.",5,null],[11,"file","","Creates a new entry type representing a regular file.",5,{"inputs":[],"output":{"name":"entrytype"}}],[11,"hard_link","","Creates a new entry type representing a hard link.",5,{"inputs":[],"output":{"name":"entrytype"}}],[11,"symlink","","Creates a new entry type representing a symlink.",5,{"inputs":[],"output":{"name":"entrytype"}}],[11,"character_special","","Creates a new entry type representing a character special device.",5,{"inputs":[],"output":{"name":"entrytype"}}],[11,"block_special","","Creates a new entry type representing a block special device.",5,{"inputs":[],"output":{"name":"entrytype"}}],[11,"dir","","Creates a new entry type representing a directory.",5,{"inputs":[],"output":{"name":"entrytype"}}],[11,"fifo","","Creates a new entry type representing a FIFO.",5,{"inputs":[],"output":{"name":"entrytype"}}],[11,"contiguous","","Creates a new entry type representing a contiguous file.",5,{"inputs":[],"output":{"name":"entrytype"}}],[11,"is_file","","Returns whether this type represents a regular file.",5,null],[11,"is_hard_link","","Returns whether this type represents a hard link.",5,null],[11,"is_symlink","","Returns whether this type represents a symlink.",5,null],[11,"is_character_special","","Returns whether this type represents a character special device.",5,null],[11,"is_block_special","","Returns whether this type represents a block special device.",5,null],[11,"is_dir","","Returns whether this type represents a directory.",5,null],[11,"is_fifo","","Returns whether this type represents a FIFO.",5,null],[11,"is_contiguous","","Returns whether this type represents a contiguous file.",5,null],[11,"is_gnu_longname","","Returns whether this type represents a GNU long name header.",5,null],[11,"is_gnu_sparse","","Returns whether this type represents a GNU sparse header.",5,null],[11,"is_gnu_longlink","","Returns whether this type represents a GNU long link header.",5,null],[11,"is_pax_global_extensions","","Returns whether this type represents a GNU long name header.",5,null],[11,"is_pax_local_extensions","","Returns whether this type represents a GNU long link header.",5,null],[11,"new_gnu","","Creates a new blank GNU header.",10,{"inputs":[],"output":{"name":"header"}}],[11,"new_ustar","","Creates a new blank UStar header.",10,{"inputs":[],"output":{"name":"header"}}],[11,"new_old","","Creates a new blank old header.",10,{"inputs":[],"output":{"name":"header"}}],[11,"as_old","","View this archive header as a raw "old" archive header.",10,null],[11,"as_old_mut","","Same as `as_old`, but the mutable version.",10,null],[11,"as_ustar","","View this archive header as a raw UStar archive header.",10,null],[11,"as_ustar_mut","","Same as `as_ustar_mut`, but the mutable version.",10,null],[11,"as_gnu","","View this archive header as a raw GNU archive header.",10,null],[11,"as_gnu_mut","","Same as `as_gnu`, but the mutable version.",10,null],[11,"as_bytes","","Returns a view into this header as a byte array.",10,null],[11,"as_mut_bytes","","Returns a view into this header as a byte array.",10,null],[11,"set_metadata","","Blanket sets the metadata in this header from the metadata argument\nprovided.",10,null],[11,"entry_size","","Returns the size of entry's data this header represents.",10,null],[11,"size","","Returns the file size this header represents.",10,null],[11,"set_size","","Encodes the `size` argument into the size field of this header.",10,null],[11,"path","","Returns the raw path name stored in this header.",10,null],[11,"path_bytes","","Returns the pathname stored in this header as a byte array.",10,null],[11,"set_path","","Sets the path name for this header.",10,null],[11,"link_name","","Returns the link name stored in this header, if any is found.",10,null],[11,"link_name_bytes","","Returns the link name stored in this header as a byte array, if any.",10,null],[11,"set_link_name","","Sets the path name for this header.",10,null],[11,"mode","","Returns the mode bits for this file",10,null],[11,"set_mode","","Encodes the `mode` provided into this header.",10,null],[11,"uid","","Returns the value of the owner's user ID field",10,null],[11,"set_uid","","Encodes the `uid` provided into this header.",10,null],[11,"gid","","Returns the value of the group's user ID field",10,null],[11,"set_gid","","Encodes the `gid` provided into this header.",10,null],[11,"mtime","","Returns the last modification time in Unix time format",10,null],[11,"set_mtime","","Encodes the `mtime` provided into this header.",10,null],[11,"username","","Return the user name of the owner of this file.",10,null],[11,"username_bytes","","Returns the user name of the owner of this file, if present.",10,null],[11,"set_username","","Sets the username inside this header.",10,null],[11,"groupname","","Return the group name of the owner of this file.",10,null],[11,"groupname_bytes","","Returns the group name of the owner of this file, if present.",10,null],[11,"set_groupname","","Sets the group name inside this header.",10,null],[11,"device_major","","Returns the device major number, if present.",10,null],[11,"set_device_major","","Encodes the value `major` into the dev_major field of this header.",10,null],[11,"device_minor","","Returns the device minor number, if present.",10,null],[11,"set_device_minor","","Encodes the value `minor` into the dev_minor field of this header.",10,null],[11,"entry_type","","Returns the type of file described by this header.",10,null],[11,"set_entry_type","","Sets the type of file that will be described by this header.",10,null],[11,"cksum","","Returns the checksum field of this header.",10,null],[11,"set_cksum","","Sets the checksum field of this header based on the current fields in\nthis header.",10,null],[11,"clone","","",10,null],[11,"path_bytes","","See `Header::path_bytes`",1,null],[11,"set_path","","See `Header::set_path`",1,null],[11,"username_bytes","","See `Header::username_bytes`",1,null],[11,"set_username","","See `Header::set_username`",1,null],[11,"groupname_bytes","","See `Header::groupname_bytes`",1,null],[11,"set_groupname","","See `Header::set_groupname`",1,null],[11,"device_major","","See `Header::device_major`",1,null],[11,"set_device_major","","See `Header::set_device_major`",1,null],[11,"device_minor","","See `Header::device_minor`",1,null],[11,"set_device_minor","","See `Header::set_device_minor`",1,null],[11,"username_bytes","","See `Header::username_bytes`",2,null],[11,"set_username","","See `Header::set_username`",2,null],[11,"groupname_bytes","","See `Header::groupname_bytes`",2,null],[11,"set_groupname","","See `Header::set_groupname`",2,null],[11,"device_major","","See `Header::device_major`",2,null],[11,"set_device_major","","See `Header::set_device_major`",2,null],[11,"device_minor","","See `Header::device_minor`",2,null],[11,"set_device_minor","","See `Header::set_device_minor`",2,null],[11,"atime","","Returns the last modification time in Unix time format",2,null],[11,"set_atime","","Encodes the `atime` provided into this header.",2,null],[11,"ctime","","Returns the last modification time in Unix time format",2,null],[11,"set_ctime","","Encodes the `ctime` provided into this header.",2,null],[11,"real_size","","Returns the "real size" of the file this header represents.",2,null],[11,"is_extended","","Indicates whether this header will be followed by additional\nsparse-header records.",2,null],[11,"is_empty","","Returns true if block is empty",3,null],[11,"offset","","Offset of the block from the start of the file",3,null],[11,"length","","Length of the block",3,null],[11,"new","","Crates a new zero'd out sparse header entry.",4,{"inputs":[],"output":{"name":"gnuextsparseheader"}}],[11,"as_bytes","","Returns a view into this header as a byte array.",4,null],[11,"as_mut_bytes","","Returns a view into this header as a byte array.",4,null],[11,"sparse","","Returns a slice of the underlying sparse headers.",4,null],[11,"is_extended","","Indicates if another sparse header should be following this one.",4,null],[11,"next","","",11,null],[11,"key","","Returns the key for this key/value pair parsed as a string.",12,null],[11,"key_bytes","","Returns the underlying raw bytes for the key of this key/value pair.",12,null],[11,"value","","Returns the value for this key/value pair parsed as a string.",12,null],[11,"value_bytes","","Returns the underlying raw bytes for this value of this key/value pair.",12,null]],"paths":[[3,"OldHeader"],[3,"UstarHeader"],[3,"GnuHeader"],[3,"GnuSparseHeader"],[3,"GnuExtSparseHeader"],[4,"EntryType"],[3,"Archive"],[3,"Entries"],[3,"Builder"],[3,"Entry"],[3,"Header"],[3,"PaxExtensions"],[3,"PaxExtension"]]};
initSearch(searchIndex);