SpecializedTranslator.swift 1.3 KB

1234567891011121314151617181920212223242526272829
  1. /*
  2. * Copyright 2023, gRPC Authors All rights reserved.
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. /// Represents one responsibility of the ``Translator``: either the type aliases translation,
  17. /// the server code translation or the client code translation.
  18. protocol SpecializedTranslator {
  19. /// Generates an array of ``CodeBlock`` elements that will be part of the ``StructuredSwiftRepresentation`` object
  20. /// created by the ``Translator``.
  21. ///
  22. /// - Parameters:
  23. /// - codeGenerationRequest: The ``CodeGenerationRequest`` object used to represent a Source IDL description of RPCs.
  24. /// - Returns: An array of ``CodeBlock`` elements.
  25. ///
  26. /// - SeeAlso: ``CodeGenerationRequest``, ``Translator``, ``CodeBlock``.
  27. func translate(from codeGenerationRequest: CodeGenerationRequest) throws -> [CodeBlock]
  28. }