feat!: ビルダーパターンの締めの"exec"/"execute"を"perform"に (#911)

BREAKING-CHANGE: メソッド名の変更。 Refs: #908
VOICEVOX · Jan 17, 2025 · a5b8d84 · a5b8d84
1 parent b94883f
commit a5b8d84
Show file tree

Hide file tree

Showing 15 changed files with 62 additions and 62 deletions.
diff --git a/crates/voicevox_core/src/__internal/doctest_fixtures.rs b/crates/voicevox_core/src/__internal/doctest_fixtures.rs
@@ -17,7 +17,7 @@ pub async fn synthesizer_with_sample_voice_model(
         #[cfg(feature = "load-onnxruntime")]
         crate::nonblocking::Onnxruntime::load_once()
             .filename(onnxruntime_dylib_path)
-            .exec()
+            .perform()
             .await?,
         #[cfg(feature = "link-onnxruntime")]
         crate::nonblocking::Onnxruntime::init_once().await?,

diff --git a/crates/voicevox_core/src/devices.rs b/crates/voicevox_core/src/devices.rs
@@ -58,7 +58,7 @@ fn test_gpu(
 ///
 /// # voicevox_core::blocking::Onnxruntime::load_once()
 /// #     .filename(test_util::ONNXRUNTIME_DYLIB_PATH)
-/// #     .exec()?;
+/// #     .perform()?;
 /// #
 /// let onnxruntime = Onnxruntime::get().unwrap();
 /// dbg!(SupportedDevices::THIS & onnxruntime.supported_devices()?);

diff --git a/crates/voicevox_core/src/infer/runtimes/onnxruntime.rs b/crates/voicevox_core/src/infer/runtimes/onnxruntime.rs
@@ -294,11 +294,11 @@ pub(crate) mod blocking {
     /// # fn main() -> anyhow::Result<()> {
     /// # voicevox_core::blocking::Onnxruntime::load_once()
     /// #     .filename(test_util::ONNXRUNTIME_DYLIB_PATH)
-    /// #     .exec()?;
+    /// #     .perform()?;
     /// #
     /// use std::ptr;
     ///
-    /// let ort1 = voicevox_core::blocking::Onnxruntime::load_once().exec()?;
+    /// let ort1 = voicevox_core::blocking::Onnxruntime::load_once().perform()?;
     /// let ort2 = another_lib::nonblocking::Onnxruntime::get().expect("`ort1`と同一のはず");
     /// assert!(ptr::addr_eq(ort1, ort2));
     /// # Ok(())
@@ -406,7 +406,7 @@ pub(crate) mod blocking {
             {
                 Self::load_once()
                     .filename(test_util::ONNXRUNTIME_DYLIB_PATH)
-                    .exec()
+                    .perform()
                     .map_err(Into::into)
             }
 
@@ -424,7 +424,7 @@ pub(crate) mod blocking {
 
     /// [`Onnxruntime::load_once`]のビルダー。
     #[cfg(feature = "load-onnxruntime")]
-    #[must_use = "this is a builder. it does nothing until `exec`uted"]
+    #[must_use = "this is a builder. it does nothing until `perform`ed"]
     pub struct LoadOnce {
         filename: std::ffi::OsString,
     }
@@ -452,7 +452,7 @@ pub(crate) mod blocking {
         }
 
         /// 実行する。
-        pub fn exec(self) -> crate::Result<&'static Onnxruntime> {
+        pub fn perform(self) -> crate::Result<&'static Onnxruntime> {
             Onnxruntime::once(|| ort::try_init_from(&self.filename, None))
         }
     }
@@ -480,10 +480,10 @@ pub(crate) mod nonblocking {
     /// # async fn main() -> anyhow::Result<()> {
     /// # voicevox_core::blocking::Onnxruntime::load_once()
     /// #     .filename(test_util::ONNXRUNTIME_DYLIB_PATH)
-    /// #     .exec()?;
+    /// #     .perform()?;
     /// #
     /// let ort1 = voicevox_core::nonblocking::Onnxruntime::load_once()
-    ///     .exec()
+    ///     .perform()
     ///     .await?;
     /// let ort2 = another_lib::blocking::Onnxruntime::get().expect("`ort1`と同一のはず");
     /// assert_eq!(ptr_addr(ort1), ptr_addr(ort2));
@@ -584,7 +584,7 @@ pub(crate) mod nonblocking {
     /// [`Onnxruntime::load_once`]のビルダー。
     #[cfg(feature = "load-onnxruntime")]
     #[derive(Default)]
-    #[must_use = "this is a builder. it does nothing until `exec`uted"]
+    #[must_use = "this is a builder. it does nothing until `perform`ed"]
     pub struct LoadOnce(super::blocking::LoadOnce);
 
     #[cfg(feature = "load-onnxruntime")]
@@ -601,8 +601,8 @@ pub(crate) mod nonblocking {
         }
 
         /// 実行する。
-        pub async fn exec(self) -> crate::Result<&'static Onnxruntime> {
-            let inner = crate::task::asyncify(|| self.0.exec()).await?;
+        pub async fn perform(self) -> crate::Result<&'static Onnxruntime> {
+            let inner = crate::task::asyncify(|| self.0.perform()).await?;
             Ok(Onnxruntime::from_blocking(inner))
         }
     }

diff --git a/crates/voicevox_core/src/synthesizer.rs b/crates/voicevox_core/src/synthesizer.rs
@@ -1201,10 +1201,10 @@ pub(crate) mod blocking {
         ///
         /// # voicevox_core::blocking::Onnxruntime::load_once()
         /// #     .filename(test_util::ONNXRUNTIME_DYLIB_PATH)
-        /// #     .exec()?;
+        /// #     .perform()?;
         /// #
         /// // FIXME: `Synthesizer`には`&mut self`なメソッドはもう無いはず
-        /// let mut syntesizer = Synthesizer::builder(Onnxruntime::load_once().exec()?)
+        /// let mut syntesizer = Synthesizer::builder(Onnxruntime::load_once().perform()?)
         ///     .open_jtalk(Arc::new(OpenJtalk::new(OPEN_JTALK_DIC_DIR).unwrap())) // FIXME: `Arc`は要らないはず
         ///     .acceleration_mode(ACCELERATION_MODE)
         ///     .build()?;
@@ -1648,7 +1648,7 @@ pub(crate) mod blocking {
         }
     }
 
-    #[must_use = "this is a builder. it does nothing until `exec`uted"]
+    #[must_use = "this is a builder. it does nothing until `perform`ed"]
     pub struct PrecomputeRender<'a> {
         synthesizer: InnerRefWithoutOpenJtalk<'a, SingleTasked>,
         audio_query: &'a AudioQuery,
@@ -1663,14 +1663,14 @@ pub(crate) mod blocking {
         }
 
         /// 実行する。
-        pub fn exec(self) -> crate::Result<AudioFeature> {
+        pub fn perform(self) -> crate::Result<AudioFeature> {
             self.synthesizer
                 .precompute_render(self.audio_query, self.style_id, &self.options)
                 .block_on()
         }
     }
 
-    #[must_use = "this is a builder. it does nothing until `exec`uted"]
+    #[must_use = "this is a builder. it does nothing until `perform`ed"]
     pub struct Synthesis<'a> {
         synthesizer: InnerRefWithoutOpenJtalk<'a, SingleTasked>,
         audio_query: &'a AudioQuery,
@@ -1685,14 +1685,14 @@ pub(crate) mod blocking {
         }
 
         /// 実行する。
-        pub fn exec(self) -> crate::Result<Vec<u8>> {
+        pub fn perform(self) -> crate::Result<Vec<u8>> {
             self.synthesizer
                 .synthesis(self.audio_query, self.style_id, &self.options)
                 .block_on()
         }
     }
 
-    #[must_use = "this is a builder. it does nothing until `exec`uted"]
+    #[must_use = "this is a builder. it does nothing until `perform`ed"]
     pub struct TtsFromKana<'a> {
         synthesizer: InnerRefWithoutOpenJtalk<'a, SingleTasked>,
         kana: &'a str,
@@ -1707,14 +1707,14 @@ pub(crate) mod blocking {
         }
 
         /// 実行する。
-        pub fn exec(self) -> crate::Result<Vec<u8>> {
+        pub fn perform(self) -> crate::Result<Vec<u8>> {
             self.synthesizer
                 .tts_from_kana(self.kana, self.style_id, &self.options)
                 .block_on()
         }
     }
 
-    #[must_use = "this is a builder. it does nothing until `exec`uted"]
+    #[must_use = "this is a builder. it does nothing until `perform`ed"]
     pub struct Tts<'a, O> {
         synthesizer: &'a Inner<O, SingleTasked>,
         text: &'a str,
@@ -1729,7 +1729,7 @@ pub(crate) mod blocking {
         }
 
         /// 実行する。
-        pub fn exec(self) -> crate::Result<Vec<u8>> {
+        pub fn perform(self) -> crate::Result<Vec<u8>> {
             self.synthesizer
                 .tts(self.text, self.style_id, &self.options)
                 .block_on()
@@ -1783,10 +1783,10 @@ pub(crate) mod nonblocking {
         ///
         /// # voicevox_core::blocking::Onnxruntime::load_once()
         /// #     .filename(test_util::ONNXRUNTIME_DYLIB_PATH)
-        /// #     .exec()?;
+        /// #     .perform()?;
         /// #
         /// // FIXME: `Synthesizer`には`&mut self`なメソッドはもう無いはず
-        /// let mut syntesizer = Synthesizer::builder(Onnxruntime::load_once().exec().await?)
+        /// let mut syntesizer = Synthesizer::builder(Onnxruntime::load_once().perform().await?)
         ///     .open_jtalk(Arc::new(OpenJtalk::new(OPEN_JTALK_DIC_DIR).await.unwrap())) // FIXME: `Arc`は要らないはず
         ///     .acceleration_mode(ACCELERATION_MODE)
         ///     .build()?;
@@ -2086,7 +2086,7 @@ pub(crate) mod nonblocking {
         }
     }
 
-    #[must_use = "this is a builder. it does nothing until `exec`uted"]
+    #[must_use = "this is a builder. it does nothing until `perform`ed"]
     pub struct Synthesis<'a> {
         synthesizer: InnerRefWithoutOpenJtalk<'a, BlockingThreadPool>,
         audio_query: &'a AudioQuery,
@@ -2101,14 +2101,14 @@ pub(crate) mod nonblocking {
         }
 
         /// 実行する。
-        pub async fn exec(self) -> crate::Result<Vec<u8>> {
+        pub async fn perform(self) -> crate::Result<Vec<u8>> {
             self.synthesizer
                 .synthesis(self.audio_query, self.style_id, &self.options)
                 .await
         }
     }
 
-    #[must_use = "this is a builder. it does nothing until `exec`uted"]
+    #[must_use = "this is a builder. it does nothing until `perform`ed"]
     pub struct TtsFromKana<'a> {
         synthesizer: InnerRefWithoutOpenJtalk<'a, BlockingThreadPool>,
         kana: &'a str,
@@ -2123,14 +2123,14 @@ pub(crate) mod nonblocking {
         }
 
         /// 実行する。
-        pub async fn exec(self) -> crate::Result<Vec<u8>> {
+        pub async fn perform(self) -> crate::Result<Vec<u8>> {
             self.synthesizer
                 .tts_from_kana(self.kana, self.style_id, &self.options)
                 .await
         }
     }
 
-    #[must_use = "this is a builder. it does nothing until `exec`uted"]
+    #[must_use = "this is a builder. it does nothing until `perform`ed"]
     pub struct Tts<'a, O> {
         synthesizer: &'a Inner<O, BlockingThreadPool>,
         text: &'a str,
@@ -2145,7 +2145,7 @@ pub(crate) mod nonblocking {
         }
 
         /// 実行する。
-        pub async fn exec(self) -> crate::Result<Vec<u8>> {
+        pub async fn perform(self) -> crate::Result<Vec<u8>> {
             self.synthesizer
                 .tts(self.text, self.style_id, &self.options)
                 .await

diff --git a/crates/voicevox_core_c_api/src/c_impls.rs b/crates/voicevox_core_c_api/src/c_impls.rs
@@ -45,7 +45,7 @@ impl VoicevoxOnnxruntime {
 
         let inner = voicevox_core::blocking::Onnxruntime::load_once()
             .filename(ensure_utf8(filename)?)
-            .exec()?;
+            .perform()?;
         Ok(Self::new(inner))
     }
 

diff --git a/crates/voicevox_core_c_api/src/compatible_engine.rs b/crates/voicevox_core_c_api/src/compatible_engine.rs
@@ -33,13 +33,13 @@ static ONNXRUNTIME: LazyLock<&'static voicevox_core::blocking::Onnxruntime> = La
             "onnxruntime",
         );
     voicevox_core::blocking::Onnxruntime::load_once()
-        .exec()
+        .perform()
         .or_else(|err| {
             warn!("{err}");
             warn!("falling back to `{alt_onnxruntime_filename}`");
             voicevox_core::blocking::Onnxruntime::load_once()
                 .filename(alt_onnxruntime_filename)
-                .exec()
+                .perform()
         })
         .unwrap_or_else(|err| {
             display_error(&err);

diff --git a/crates/voicevox_core_c_api/src/lib.rs b/crates/voicevox_core_c_api/src/lib.rs
@@ -1087,7 +1087,7 @@ pub unsafe extern "C" fn voicevox_synthesizer_synthesis(
             .body()
             .synthesis(&audio_query, StyleId::new(style_id))
             .enable_interrogative_upspeak(enable_interrogative_upspeak)
-            .exec()?;
+            .perform()?;
         U8_SLICE_OWNER.own_and_lend(wav, output_wav, output_wav_length);
         Ok(())
     })())
@@ -1149,7 +1149,7 @@ pub unsafe extern "C" fn voicevox_synthesizer_tts_from_kana(
             .body()
             .tts_from_kana(kana, StyleId::new(style_id))
             .enable_interrogative_upspeak(enable_interrogative_upspeak)
-            .exec()?;
+            .perform()?;
         U8_SLICE_OWNER.own_and_lend(output, output_wav, output_wav_length);
         Ok(())
     })())
@@ -1194,7 +1194,7 @@ pub unsafe extern "C" fn voicevox_synthesizer_tts(
             .body()
             .tts(text, StyleId::new(style_id))
             .enable_interrogative_upspeak(enable_interrogative_upspeak)
-            .exec()?;
+            .perform()?;
         U8_SLICE_OWNER.own_and_lend(output, output_wav, output_wav_length);
         Ok(())
     })())

diff --git a/...cevox_core_java_api/lib/src/main/java/jp/hiroshiba/voicevoxcore/blocking/Onnxruntime.java b/...cevox_core_java_api/lib/src/main/java/jp/hiroshiba/voicevoxcore/blocking/Onnxruntime.java
@@ -14,7 +14,7 @@
  * <p>シングルトンであり、インスタンスは高々一つ。
  *
  * <pre>
- * Onnxruntime ort1 = Onnxruntime.loadOnce().exec();
+ * Onnxruntime ort1 = Onnxruntime.loadOnce().perform();
  * Onnxruntime ort2 = Onnxruntime.get().get();
  * assert ort1 == ort2;
  * </pre>
@@ -96,7 +96,7 @@ public LoadOnce filename(@Nonnull String filename) {
      *
      * @return {@link Onnxruntime}。
      */
-    public Onnxruntime exec() {
+    public Onnxruntime perform() {
       synchronized (Onnxruntime.class) {
         if (instance == null) {
           instance = new Onnxruntime(filename);

diff --git a/...cevox_core_java_api/lib/src/main/java/jp/hiroshiba/voicevoxcore/blocking/Synthesizer.java b/...cevox_core_java_api/lib/src/main/java/jp/hiroshiba/voicevoxcore/blocking/Synthesizer.java
@@ -253,7 +253,7 @@ public List<AccentPhrase> replaceMoraPitch(List<AccentPhrase> accentPhrases, int
    * @param audioQuery {@link AudioQuery}。
    * @param styleId スタイルID。
    * @return {@link SynthesisConfigurator}。
-   * @see SynthesisConfigurator#execute
+   * @see SynthesisConfigurator#perform
    */
   @Nonnull
   public SynthesisConfigurator synthesis(AudioQuery audioQuery, int styleId) {
@@ -266,7 +266,7 @@ public SynthesisConfigurator synthesis(AudioQuery audioQuery, int styleId) {
    * @param kana AquesTalk風記法。
    * @param styleId スタイルID。
    * @return {@link TtsFromKanaConfigurator}。
-   * @see TtsFromKanaConfigurator#execute
+   * @see TtsFromKanaConfigurator#perform
    */
   @Nonnull
   public TtsFromKanaConfigurator ttsFromKana(String kana, int styleId) {
@@ -279,7 +279,7 @@ public TtsFromKanaConfigurator ttsFromKana(String kana, int styleId) {
    * @param text 日本語のテキスト。
    * @param styleId スタイルID。
    * @return {@link TtsConfigurator}。
-   * @see TtsConfigurator#execute
+   * @see TtsConfigurator#perform
    */
   @Nonnull
   public TtsConfigurator tts(String text, int styleId) {
@@ -434,7 +434,7 @@ public SynthesisConfigurator interrogativeUpspeak(boolean interrogativeUpspeak)
      * @throws RunModelException 推論に失敗した場合。
      */
     @Nonnull
-    public byte[] execute() throws RunModelException {
+    public byte[] perform() throws RunModelException {
       if (!Utils.isU32(styleId)) {
         throw new IllegalArgumentException("styleId");
       }
@@ -479,7 +479,7 @@ public TtsFromKanaConfigurator interrogativeUpspeak(boolean interrogativeUpspeak
      * @throws RunModelException 推論に失敗した場合。
      */
     @Nonnull
-    public byte[] execute() throws RunModelException {
+    public byte[] perform() throws RunModelException {
       if (!Utils.isU32(styleId)) {
         throw new IllegalArgumentException("styleId");
       }
@@ -522,7 +522,7 @@ public TtsConfigurator interrogativeUpspeak(boolean interrogativeUpspeak) {
      * @throws RunModelException 推論に失敗した場合。
      */
     @Nonnull
-    public byte[] execute() throws RunModelException {
+    public byte[] perform() throws RunModelException {
       if (!Utils.isU32(styleId)) {
         throw new IllegalArgumentException("styleId");
       }

diff --git a/crates/voicevox_core_java_api/lib/src/test/java/jp/hiroshiba/voicevoxcore/TestUtils.java b/crates/voicevox_core_java_api/lib/src/test/java/jp/hiroshiba/voicevoxcore/TestUtils.java
@@ -24,7 +24,7 @@ protected Onnxruntime loadOnnxruntime() {
             + Onnxruntime.LIB_VERSIONED_FILENAME.replace("voicevox_onnxruntime", "onnxruntime");
 
     try {
-      return Onnxruntime.loadOnce().filename(FILENAME).exec();
+      return Onnxruntime.loadOnce().filename(FILENAME).perform();
     } catch (Exception e) {
       throw new RuntimeException(e);
     }

diff --git a/...x_core_java_api/lib/src/test/java/jp/hiroshiba/voicevoxcore/blocking/SynthesizerTest.java b/...x_core_java_api/lib/src/test/java/jp/hiroshiba/voicevoxcore/blocking/SynthesizerTest.java
@@ -81,7 +81,7 @@ void checkAudioQuery() throws RunModelException, InvalidModelDataException {
     }
 
     AudioQuery query = synthesizer.createAudioQuery("こんにちは", synthesizer.metas()[0].styles[0].id);
-    synthesizer.synthesis(query, synthesizer.metas()[0].styles[0].id).execute();
+    synthesizer.synthesis(query, synthesizer.metas()[0].styles[0].id).perform();
   }
 
   @Test
@@ -124,6 +124,6 @@ void checkTts() throws RunModelException, InvalidModelDataException {
     try (VoiceModelFile model = openModel()) {
       synthesizer.loadVoiceModel(model);
     }
-    synthesizer.tts("こんにちは", synthesizer.metas()[0].styles[0].id).execute();
+    synthesizer.tts("こんにちは", synthesizer.metas()[0].styles[0].id).perform();
   }
 }
diff --git a/crates/voicevox_core_java_api/src/onnxruntime.rs b/crates/voicevox_core_java_api/src/onnxruntime.rs
@@ -36,7 +36,7 @@ unsafe extern "system" fn Java_jp_hiroshiba_voicevoxcore_blocking_Onnxruntime_rs
         let filename = String::from(env.get_string(&filename)?);
         let internal = voicevox_core::blocking::Onnxruntime::load_once()
             .filename(filename)
-            .exec()?;
+            .perform()?;
         env.set_rust_field(&this, "handle", internal)?;
         Ok(())
     })