Replace SubtitleFile with SubtitleFileInterface

Author: kaegi

examples/example2.rs

@@ -1,7 +1,7 @@
 extern crate subparse;
 
 use subparse::timetypes::{TimePoint, TimeSpan};
-use subparse::{SrtFile, SubtitleFile};
+use subparse::{SrtFile, SubtitleFileInterface};
 
 fn main() {
     // example how to create a fresh .srt file

src/formats/idx.rs

@@ -5,7 +5,7 @@
 use self::errors::ErrorKind::*; // the crate wide error type (we use a custom error type here)
 use self::errors::*;
 use super::common::*;
-use crate::{SubtitleEntry, SubtitleFile};
+use crate::{SubtitleEntry, SubtitleFileInterface};
 
 use crate::errors::Result as SubtitleParserResult;
 use combine::char::*;
@@ -66,7 +66,7 @@ impl IdxFile {
     }
 }
 
-impl SubtitleFile for IdxFile {
+impl SubtitleFileInterface for IdxFile {
     fn get_subtitle_entries(&self) -> SubtitleParserResult<Vec<SubtitleEntry>> {
         let timings: Vec<_> = self
             .v

src/formats/microdvd.rs

@@ -4,7 +4,7 @@
 
 use self::errors::ErrorKind::*;
 use self::errors::*;
-use crate::{SubtitleEntry, SubtitleFile};
+use crate::{SubtitleEntry, SubtitleFileInterface};
 
 use crate::errors::Result as SubtitleParserResult;
 use crate::formats::common::*;
@@ -233,7 +233,7 @@ impl MdvdFile {
     }
 }
 
-impl SubtitleFile for MdvdFile {
+impl SubtitleFileInterface for MdvdFile {
     fn get_subtitle_entries(&self) -> SubtitleParserResult<Vec<SubtitleEntry>> {
         Ok(self.v.iter().map(|line| line.to_subtitle_entry(self.fps)).collect())
     }
@@ -339,7 +339,7 @@ impl SubtitleFile for MdvdFile {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use SubtitleFile;
+    use SubtitleFileInterface;
 
     /// Parse string with `MdvdFile`, and reencode it with `MdvdFile`.
     fn mdvd_reconstruct(s: &str) -> String {

src/formats/mod.rs

@@ -10,7 +10,7 @@ pub mod ssa;
 pub mod vobsub;
 
 use crate::errors::*;
-use crate::SubtitleFile;
+use crate::SubtitleFileInterface;
 use encoding_rs::Encoding;
 use std::ffi::OsStr;
 
@@ -124,22 +124,22 @@ pub fn get_subtitle_format_err(extension: Option<&OsStr>, content: &[u8]) -> Res
 }
 
 /// This trick works around the limitation, that trait objects can not require Sized (or Clone).
-pub trait ClonableSubtitleFile: SubtitleFile + Send + Sync {
+pub trait ClonableSubtitleFileInterface: SubtitleFileInterface + Send + Sync {
     /// Returns a boxed clone
-    fn clone_box(&self) -> Box<ClonableSubtitleFile>;
+    fn clone_box(&self) -> Box<ClonableSubtitleFileInterface>;
 }
-impl<T> ClonableSubtitleFile for T
+impl<T> ClonableSubtitleFileInterface for T
 where
-    T: SubtitleFile + Clone + Send + Sync + 'static,
+    T: SubtitleFileInterface + Clone + Send + Sync + 'static,
 {
-    fn clone_box(&self) -> Box<ClonableSubtitleFile> {
+    fn clone_box(&self) -> Box<ClonableSubtitleFileInterface> {
         Box::new(Clone::clone(self))
     }
 }
 
 // We can now implement Clone manually by forwarding to clone_box.
-impl Clone for Box<ClonableSubtitleFile> {
-    fn clone(&self) -> Box<ClonableSubtitleFile> {
+impl Clone for Box<ClonableSubtitleFileInterface> {
+    fn clone(&self) -> Box<ClonableSubtitleFileInterface> {
         self.clone_box()
     }
 }
@@ -151,7 +151,7 @@ impl Clone for Box<ClonableSubtitleFile> {
 /// # Mandatory format specific options
 ///
 /// See `parse_bytes`.
-pub fn parse_str(format: SubtitleFormat, content: &str, fps: f64) -> Result<Box<ClonableSubtitleFile>> {
+pub fn parse_str(format: SubtitleFormat, content: &str, fps: f64) -> Result<Box<ClonableSubtitleFileInterface>> {
     match format {
         SubtitleFormat::SubRip => Ok(Box::new(srt::SrtFile::parse(content)?)),
         SubtitleFormat::SubStationAlpha => Ok(Box::new(ssa::SsaFile::parse(content)?)),
@@ -185,7 +185,7 @@ fn decode_bytes_to_string(content: &[u8], encoding: &'static Encoding) -> Result
 /// seconds/minutes/... but in frame numbers. So the timing `0 to 30` means "show subtitle for one second"
 /// for a 30fps video, and "show subtitle for half second" for 60fps videos. The parameter specifies how
 /// frame numbers are converted into timestamps.
-pub fn parse_bytes(format: SubtitleFormat, content: &[u8], encoding: &'static Encoding, fps: f64) -> Result<Box<ClonableSubtitleFile>> {
+pub fn parse_bytes(format: SubtitleFormat, content: &[u8], encoding: &'static Encoding, fps: f64) -> Result<Box<ClonableSubtitleFileInterface>> {
     match format {
         SubtitleFormat::SubRip => Ok(Box::new(srt::SrtFile::parse(&decode_bytes_to_string(content, encoding)?)?)),
         SubtitleFormat::SubStationAlpha => Ok(Box::new(ssa::SsaFile::parse(&decode_bytes_to_string(content, encoding)?)?)),

src/formats/srt.rs

@@ -4,7 +4,7 @@
 
 use self::errors::ErrorKind::*;
 use self::errors::*;
-use crate::{SubtitleEntry, SubtitleFile};
+use crate::{SubtitleEntry, SubtitleFileInterface};
 
 use crate::errors::Result as SubtitleParserResult;
 use crate::formats::common::*;
@@ -171,7 +171,7 @@ impl SrtFile {
     }
 }
 
-impl SubtitleFile for SrtFile {
+impl SubtitleFileInterface for SrtFile {
     fn get_subtitle_entries(&self) -> SubtitleParserResult<Vec<SubtitleEntry>> {
         let timings = self
             .v
@@ -234,7 +234,7 @@ mod tests {
     #[test]
     fn create_srt_test() {
         use crate::timetypes::{TimePoint, TimeSpan};
-        use crate::SubtitleFile;
+        use crate::SubtitleFileInterface;
 
         let lines = vec![
             (

src/formats/ssa.rs

@@ -2,7 +2,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-use crate::{SubtitleEntry, SubtitleFile};
+use crate::{SubtitleEntry, SubtitleFileInterface};
 
 use crate::errors::Result as SubtitleParserResult;
 use crate::formats::common::*;
@@ -409,7 +409,7 @@ impl SsaFile {
     }
 }
 
-impl SubtitleFile for SsaFile {
+impl SubtitleFileInterface for SsaFile {
     fn get_subtitle_entries(&self) -> SubtitleParserResult<Vec<SubtitleEntry>> {
         // it's unfortunate we have to clone the file before using
         // `get_subtitle_entries_mut()`, but otherwise we'd have to copy the`

src/formats/vobsub.rs

@@ -5,7 +5,7 @@
 use self::errors::*;
 use crate::errors::Result as SubtitleParserResult;
 use crate::timetypes::{TimePoint, TimeSpan};
-use crate::{SubtitleEntry, SubtitleFile, SubtitleFormat};
+use crate::{SubtitleEntry, SubtitleFileInterface, SubtitleFormat};
 use failure::ResultExt;
 
 use vobsub;
@@ -70,7 +70,7 @@ impl VobFile {
     }
 }
 
-impl SubtitleFile for VobFile {
+impl SubtitleFileInterface for VobFile {
     fn get_subtitle_entries(&self) -> SubtitleParserResult<Vec<SubtitleEntry>> {
         Ok(self
             .lines

src/lib.rs

@@ -45,13 +45,13 @@ pub use formats::{
     get_subtitle_format, get_subtitle_format_by_extension, get_subtitle_format_by_extension_err, get_subtitle_format_err,
     is_valid_extension_for_subtitle_format, parse_bytes, parse_str,
 };
-pub use formats::{ClonableSubtitleFile, SubtitleFormat};
+pub use formats::{ClonableSubtitleFileInterface, SubtitleFormat};
 use timetypes::TimeSpan;
 
 /// This trait represents the generic interface for reading and writing subtitle information across all subtitle formats.
 ///
 /// This trait allows you to read, change and rewrite the subtitle file.
-pub trait SubtitleFile {
+pub trait SubtitleFileInterface {
     /// The subtitle entries can be changed by calling `update_subtitle_entries()`.
     fn get_subtitle_entries(&self) -> Result<Vec<SubtitleEntry>>;