docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class FileCompressor

    Since C# only has GZipStream until .NET 4.0, we are forced to implement our own packing system for artifact files. We compact all artifacts into a single GZip Stream with the header before the file name and contents. The header contains the file name length and file length (in bytes).

    Inheritance
    object
    FileCompressor
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEditor.Build.Pipeline.Utilities
    Assembly: Unity.ScriptableBuildPipeline.Editor.dll
    Syntax
    public class FileCompressor

    Methods

    Compress(string, string)

    Compresses all artifacts located at a specified directory.

    Declaration
    public static bool Compress(string directoryPath, string archiveFilePath)
    Parameters
    Type Name Description
    string directoryPath

    The directory containing the artifacts.

    string archiveFilePath

    The file path at which the archive will be created.

    Returns
    Type Description
    bool

    Returns true if the directory was found and compressed. Returns false otherwise.

    Decompress(string, string)

    Extracts all artifacts compressed in an archive.

    Declaration
    public static bool Decompress(string archiveFilePath, string directoryPath)
    Parameters
    Type Name Description
    string archiveFilePath

    The archive to decompress.

    string directoryPath

    The path where the extracted artifacts will be stored.

    Returns
    Type Description
    bool

    Returns true if the archive was found and decompressed. Returns false otherwise.


    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • Methods
      • Compress(string, string)
      • Decompress(string, string)
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)