var searchIndex = {};
searchIndex["substudy"] = {"doc":"Tools for studying foreign languages using subtitles.  All APIs are\ncurrently experimental or unstable, but if you'd like me to stabilize\nthings, please get in touch.","items":[[0,"err","substudy","Error-handling for this library.",null,null],[4,"SubStudyError","substudy::err","Our library's error class.  This may grow new enumeration values.",null,null],[13,"Io","","Error reading or writing subtitle data.",0,null],[13,"EncodingDetector","","Error detecting the subtitle encoding.",0,null],[13,"Decode","","Error decoding the subtiles to UTF-8.",0,null],[13,"Parse","","An error which occurred while parsing subtitle data.",0,null],[6,"SubStudyResult","","Our library's result type.",null,null],[11,"fmt","","",0,null],[11,"description","","",0,null],[11,"cause","","",0,null],[11,"fmt","","",0,null],[11,"from","","",0,{"inputs":[{"name":"ioerror"}],"output":{"name":"substudyerror"}}],[11,"from","","",0,{"inputs":[{"name":"encodingdetectorerror"}],"output":{"name":"substudyerror"}}],[0,"decode","substudy","Decode text in a wide variety of character encodings.",null,null],[5,"smart_decode","substudy::decode","Guess the encoding of a byte buffer and decode it to a string.",null,null],[0,"srt","substudy","SRT-format subtitle support.",null,null],[3,"Subtitle","substudy::srt","A single SRT-format subtitle, minus some of the optional fields used in\nvarious versions of the file format.",null,null],[12,"index","","The index of this subtitle.  We should normalize these to start\nwith 1 on output.",1,null],[12,"begin","","The start time of this subtitle, in seconds.",1,null],[12,"end","","The end time of this subtitle, in seconds.",1,null],[12,"lines","","The lines of text in this subtitle.",1,null],[3,"SubtitleFile","","The contents of an SRT-format subtitle file.",null,null],[12,"subtitles","","The subtitles in this file.",2,null],[5,"format_time","","Format seconds using the standard SRT time format.",null,{"inputs":[{"name":"f32"}],"output":{"name":"string"}}],[11,"clone","","",1,null],[11,"eq","","",1,null],[11,"ne","","",1,null],[11,"fmt","","",1,null],[11,"to_string","","Return a string representation of this subtitle.",1,null],[11,"eq","","",2,null],[11,"ne","","",2,null],[11,"fmt","","",2,null],[11,"from_str","","Parse raw subtitle text into an appropriate structure.",2,{"inputs":[{"name":"str"}],"output":{"name":"substudyresult"}}],[11,"from_path","","Parse the subtitle file found at the specified path.",2,{"inputs":[{"name":"path"}],"output":{"name":"substudyresult"}}],[11,"to_string","","Convert subtitles to a string.",2,null],[0,"clean","substudy","Tools for cleaning up subtitle files and getting them into some\nkind of normalized format.",null,null],[5,"clean_subtitle_file","substudy::clean","Clean up various issues with subtitle files, including:",null,{"inputs":[{"name":"subtitlefile"}],"output":{"name":"subtitlefile"}}],[0,"merge","substudy","Tools for merge multiple subtitles into one.",null,null],[5,"merge_subtitles","substudy::merge","Merge several subtitles into a single subtitle.  Returns `None` if no\nsubtitles have been supplied, or if the resulting subtitle has no text.",null,null],[0,"align","substudy","Align two subtitle files.",null,null],[5,"align_files","substudy::align","Align two subtitle files, merging subtitles as necessary.",null,{"inputs":[{"name":"subtitlefile"},{"name":"subtitlefile"}],"output":{"name":"vec"}}],[5,"combine_files","","Combine two subtitle files into an aligned file.",null,{"inputs":[{"name":"subtitlefile"},{"name":"subtitlefile"}],"output":{"name":"subtitlefile"}}]],"paths":[[4,"SubStudyError"],[3,"Subtitle"],[3,"SubtitleFile"]]};
initSearch(searchIndex);