com.sass_lang.embedded_protocol

Class OutboundMessage.CanonicalizeRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.sass_lang.embedded_protocol.OutboundMessage.CanonicalizeRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OutboundMessage.CanonicalizeRequestOrBuilder, Serializable

Enclosing class:

OutboundMessage

public static final class OutboundMessage.CanonicalizeRequest
extends com.google.protobuf.GeneratedMessage
implements OutboundMessage.CanonicalizeRequestOrBuilder

 A request for a custom importer to convert an imported URL to its canonical
 format.

 If the URL is not recognized by this importer, or if no stylesheet is found
 at that URL, `CanonicalizeResponse.result` must be `null`. Otherwise, the
 importer must return an absolute URL, including a scheme.

 > The host's documentation should encourage the use of file importers (via
 > `CompileRequest.Importer.file_importer_id`, `FileImportRequest`, and
 > `FileImportResponse`) for any importers that simply refer to files on
 > disk. This will allow Sass to handle the logic of resolving partials,
 > file extensions, and index files.

 If Sass has already loaded a stylesheet with the returned canonical URL, it
 re-uses the existing parse tree. This means that importers must ensure that
 the same canonical URL always refers to the same stylesheet, *even across
 different importers*. Importers must also ensure that any canonicalized
 URLs they return can be passed back to `CanonicalizeRequest` and will be
 returned unchanged.

 If this importer's URL format supports file extensions, it should
 canonicalize them the same way as the default filesystem importer:

 * The importer should look for stylesheets by adding the prefix `_` to the
 URL's basename, and by adding the extensions `.sass` and `.scss` if the
 URL doesn't already have one of those extensions. For example, if the URL
 was `foo/bar/baz`, the importer would look for:

 * `foo/bar/baz.sass`
 * `foo/bar/baz.scss`
 * `foo/bar/_baz.sass`
 * `foo/bar/_baz.scss`

 If the URL was foo/bar/baz.scss, the importer would just look for:

 * `foo/bar/baz.scss`
 * `foo/bar/_baz.scss`

 If the importer finds a stylesheet at more than one of these URLs, it
 should respond with a `CanonicalizeResponse.result.error` indicating that
 the import is ambiguous. Note that if the extension is explicitly
 specified, a stylesheet with another extension may exist without error.

 * If none of the possible paths is valid, the importer should perform the
 same resolution on the URL followed by `/index`. In the example above, it
 would look for:

 * `foo/bar/baz/_index.sass`
 * `foo/bar/baz/index.sass`
 * `foo/bar/baz/_index.scss`
 * `foo/bar/baz/index.scss`

 As above, if the importer finds a stylesheet at more than one of these
 URLs, it should respond with a `CanonicalizeResponse.result.error`
 indicating that the import is ambiguous.
 

Protobuf type sass.embedded_protocol.OutboundMessage.CanonicalizeRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OutboundMessage.CanonicalizeRequest.Builder A request for a custom importer to convert an imported URL to its canonical format.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTAINING_URL_FIELD_NUMBER
static int	FROM_IMPORT_FIELD_NUMBER
static int	ID_FIELD_NUMBER
static int	IMPORTER_ID_FIELD_NUMBER
static int	URL_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getContainingUrl() The canonical URL of the [current source file] that contained the load to be canonicalized.
com.google.protobuf.ByteString	getContainingUrlBytes() The canonical URL of the [current source file] that contained the load to be canonicalized.
static OutboundMessage.CanonicalizeRequest	getDefaultInstance()
OutboundMessage.CanonicalizeRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getFromImport() Whether this request comes from an `@import` rule.
int	getId() uint32 id = 1;
int	getImporterId() The unique ID of the importer being invoked.
com.google.protobuf.Parser<OutboundMessage.CanonicalizeRequest>	getParserForType()
int	getSerializedSize()
String	getUrl() The URL of the import to be canonicalized.
com.google.protobuf.ByteString	getUrlBytes() The URL of the import to be canonicalized.
boolean	hasContainingUrl() The canonical URL of the [current source file] that contained the load to be canonicalized.
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static OutboundMessage.CanonicalizeRequest.Builder	newBuilder()
static OutboundMessage.CanonicalizeRequest.Builder	newBuilder(OutboundMessage.CanonicalizeRequest prototype)
OutboundMessage.CanonicalizeRequest.Builder	newBuilderForType()
protected OutboundMessage.CanonicalizeRequest.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static OutboundMessage.CanonicalizeRequest	parseDelimitedFrom(InputStream input)
static OutboundMessage.CanonicalizeRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OutboundMessage.CanonicalizeRequest	parseFrom(byte[] data)
static OutboundMessage.CanonicalizeRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OutboundMessage.CanonicalizeRequest	parseFrom(ByteBuffer data)
static OutboundMessage.CanonicalizeRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OutboundMessage.CanonicalizeRequest	parseFrom(com.google.protobuf.ByteString data)
static OutboundMessage.CanonicalizeRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OutboundMessage.CanonicalizeRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static OutboundMessage.CanonicalizeRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OutboundMessage.CanonicalizeRequest	parseFrom(InputStream input)
static OutboundMessage.CanonicalizeRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<OutboundMessage.CanonicalizeRequest>	parser()
OutboundMessage.CanonicalizeRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

See Also:

Constant Field Values

IMPORTER_ID_FIELD_NUMBER

public static final int IMPORTER_ID_FIELD_NUMBER

See Also:

Constant Field Values

URL_FIELD_NUMBER

public static final int URL_FIELD_NUMBER

See Also:

Constant Field Values

FROM_IMPORT_FIELD_NUMBER

public static final int FROM_IMPORT_FIELD_NUMBER

See Also:

Constant Field Values

CONTAINING_URL_FIELD_NUMBER

public static final int CONTAINING_URL_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getId

public int getId()

uint32 id = 1;

Specified by:

getId in interface OutboundMessage.CanonicalizeRequestOrBuilder

Returns:

The id.

getImporterId

public int getImporterId()

 The unique ID of the importer being invoked. This must match an importer
 ID passed to this compilation in `CompileRequest.importers` or
 `CompileRequest.input.string.importer`.
 

uint32 importer_id = 3;

Specified by:

getImporterId in interface OutboundMessage.CanonicalizeRequestOrBuilder

Returns:

The importerId.

getUrl

public String getUrl()

 The URL of the import to be canonicalized. This may be either absolute or
 relative.

 When loading a URL, the compiler must first try resolving that URL
 relative to the canonical URL of the current file, and canonicalizing the
 result using the importer that loaded the current file. If this returns
 `null`, the compiler must then try canonicalizing the original URL with
 each importer in order until one returns something other than `null`.
 That is the result of the import.
 

string url = 4;

Specified by:

getUrl in interface OutboundMessage.CanonicalizeRequestOrBuilder

Returns:

The url.

getUrlBytes

public com.google.protobuf.ByteString getUrlBytes()

 The URL of the import to be canonicalized. This may be either absolute or
 relative.

 When loading a URL, the compiler must first try resolving that URL
 relative to the canonical URL of the current file, and canonicalizing the
 result using the importer that loaded the current file. If this returns
 `null`, the compiler must then try canonicalizing the original URL with
 each importer in order until one returns something other than `null`.
 That is the result of the import.
 

string url = 4;

Specified by:

getUrlBytes in interface OutboundMessage.CanonicalizeRequestOrBuilder

Returns:

The bytes for url.

getFromImport

public boolean getFromImport()

 Whether this request comes from an `@import` rule.

 When evaluating `@import` rules, URLs should canonicalize to an
 [import-only file] if one exists for the URL being canonicalized.
 Otherwise, canonicalization should be identical for `@import` and `@use`
 rules.

 [import-only file]: https://sass-lang.com/documentation/at-rules/import#import-only-files
 

bool from_import = 5;

Specified by:

getFromImport in interface OutboundMessage.CanonicalizeRequestOrBuilder

Returns:

The fromImport.

hasContainingUrl

public boolean hasContainingUrl()

 The canonical URL of the [current source file] that contained the load
 to be canonicalized.

 [current source file]: ../spec.md#current-source-file

 The compiler must set this if and only if `url` is relative or its
 scheme is an `Importer.non_canonical_scheme` for the importer being
 invoked, unless the current source file has no canonical URL.

 [non-canonical-proto]: #non_canonical_scheme
 

optional string containing_url = 6;

Specified by:

hasContainingUrl in interface OutboundMessage.CanonicalizeRequestOrBuilder

Returns:

Whether the containingUrl field is set.

getContainingUrl

public String getContainingUrl()

 The canonical URL of the [current source file] that contained the load
 to be canonicalized.

 [current source file]: ../spec.md#current-source-file

 The compiler must set this if and only if `url` is relative or its
 scheme is an `Importer.non_canonical_scheme` for the importer being
 invoked, unless the current source file has no canonical URL.

 [non-canonical-proto]: #non_canonical_scheme
 

optional string containing_url = 6;

Specified by:

getContainingUrl in interface OutboundMessage.CanonicalizeRequestOrBuilder

Returns:

The containingUrl.

getContainingUrlBytes

public com.google.protobuf.ByteString getContainingUrlBytes()

 The canonical URL of the [current source file] that contained the load
 to be canonicalized.

 [current source file]: ../spec.md#current-source-file

 The compiler must set this if and only if `url` is relative or its
 scheme is an `Importer.non_canonical_scheme` for the importer being
 invoked, unless the current source file has no canonical URL.

 [non-canonical-proto]: #non_canonical_scheme
 

optional string containing_url = 6;

Specified by:

getContainingUrlBytes in interface OutboundMessage.CanonicalizeRequestOrBuilder

Returns:

The bytes for containingUrl.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static OutboundMessage.CanonicalizeRequest parseFrom(ByteBuffer data)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OutboundMessage.CanonicalizeRequest parseFrom(ByteBuffer data,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OutboundMessage.CanonicalizeRequest parseFrom(com.google.protobuf.ByteString data)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OutboundMessage.CanonicalizeRequest parseFrom(com.google.protobuf.ByteString data,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OutboundMessage.CanonicalizeRequest parseFrom(byte[] data)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OutboundMessage.CanonicalizeRequest parseFrom(byte[] data,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OutboundMessage.CanonicalizeRequest parseFrom(InputStream input)
                                                     throws IOException

Throws:

IOException

parseFrom

public static OutboundMessage.CanonicalizeRequest parseFrom(InputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static OutboundMessage.CanonicalizeRequest parseDelimitedFrom(InputStream input)
                                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static OutboundMessage.CanonicalizeRequest parseDelimitedFrom(InputStream input,
                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                              throws IOException

Throws:

IOException

parseFrom

public static OutboundMessage.CanonicalizeRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                                     throws IOException

Throws:

IOException

parseFrom

public static OutboundMessage.CanonicalizeRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws IOException

Throws:

IOException

newBuilderForType

public OutboundMessage.CanonicalizeRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static OutboundMessage.CanonicalizeRequest.Builder newBuilder()

newBuilder

public static OutboundMessage.CanonicalizeRequest.Builder newBuilder(OutboundMessage.CanonicalizeRequest prototype)

toBuilder

public OutboundMessage.CanonicalizeRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected OutboundMessage.CanonicalizeRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static OutboundMessage.CanonicalizeRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<OutboundMessage.CanonicalizeRequest> parser()

getParserForType

public com.google.protobuf.Parser<OutboundMessage.CanonicalizeRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public OutboundMessage.CanonicalizeRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder